.. _Installation:

Installation
============

1. Copy the downloaded jar file into the ``lib`` directory of the Wowza installation
2. Add the required module(s) to the list of modules in the desired application. To see which
   particular modules you need to add, please read the use-cases section of the documentation.

   .. code-block:: xml

    <Modules>
        ...
        <Module>
            <!-- This module is only required for Open Captions -->
            <Name>ModuleLiveOpenCaptions</Name>
            <Description>ModuleLiveOpenCaptions</Description>
            <Class>com.raskenlund.caption.ModuleLiveOpenCaptions</Class>
        </Module>
        <Module>
            <Name>ModuleOnTextDataToCEA608</Name>
            <Description>ModuleOnTextDataToCEA608</Description>
            <Class>com.raskenlund.caption.ModuleOnTextDataToCEA608</Class>
        </Module>
        <Module>
            <!-- This module is only required if you want to do Speech To Text with AWS Transcribe -->
            <Name>ModuleLiveTranscribe</Name>
            <Description>ModuleLiveTranscribe</Description>
            <Class>com.raskenlund.caption.ModuleLiveTranscribe</Class>
        </Module>
    </Modules>

3. You also need to set the ``raskenlund.804.license`` application property:

.. code-block:: xml

    <Property>
        <Name>raskenlund.804.license</Name>
        <Value>W804-1038-xxxx-xxxx-xxxx</Value>
        <Type>String</Type>
    </Property>

.. warning::

    If you set the caption ingest to CEA608 method using Wowza Engine Manager UI, it will replace the
    module with ``com.wowza.wms.timedtext.live.module.ModuleOnTextDataToCEA608``

    Please make sure that the only CEA608 related module listed under ``<Modules>`` is the module
    that lives in the ``com.raskenlund.caption`` Java package. Having both modules installed
    can lead to flickering and broken captions.

    When the Raskenlund module is installed properly, the Engine Manager UI will still display None
    caption source:

    .. image:: images/enginemanager-cc-sources.png

3. Add the below snippet to the ``VHost.xml`` to enable the REST API. Please make sure this is
   not placed after an other provider that would catch similar requests, eg.
   after one that would match * requests.

   Don't forget that there can be multiple actively used ``HostPort`` entries in your configuration
   and you need to add the HTTP provider to the one on which you are planning to receive API calls.

   The authentication method can be set to any of the values supported by Wowza
   Streaming Engine, it is set to `none` below for simplicity.

   .. code-block:: xml

    <HTTPProvider>
        <BaseClass>com.raskenlund.caption.HttpProviderCaptionApi</BaseClass>
        <RequestFilters>captions*</RequestFilters>
        <AuthenticationMethod>none</AuthenticationMethod>
    </HTTPProvider>

4. Once the modules have been installed, please restart Wowza Streaming Engine.