Installation¶

Copy the downloaded jar file into the lib directory of the Wowza installation

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.

<Modules>
    ...
    <Module>
        <!-- This module is only required for Open Captions -->
        <Name>ModuleLiveOpenCaptions</Name>
        <Description>ModuleLiveOpenCaptions</Description>
        <Class>io.ztream.scribe.ModuleLiveOpenCaptions</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>io.ztream.scribe.ModuleLiveTranscribe</Class>
    </Module>
    <Module>
        <!-- This module is only required if you want to use captions in StreamNameGroup streams -->
        <Name>ModuleAMLSTWebVTT</Name>
        <Description>ModuleAMLSTWebVTT</Description>
        <Class>io.ztream.scribe.ModuleAMLSTWebVTT</Class>
    </Module>
</Modules>

You also need to set the ztream.804.license application property:

<Property>
    <Name>ztream.804.license</Name>
    <Value>key/eyJhY2NvdW50Ijp7ImlkIjoiYzFkMWY2YmItZTVj....</Value>
    <Type>String</Type>
</Property>

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.
```
<HTTPProvider>
    <BaseClass>io.ztream.scribe.HttpProviderCaptionApi</BaseClass>
    <RequestFilters>captions*</RequestFilters>
    <AuthenticationMethod>none</AuthenticationMethod>
</HTTPProvider>
```

4. If you are using open captions on a Linux server and the “headless” JVM shipped with Wowza Streaming Engine, you need to have the font manager and at least one font installed:

sudo apt-get install fontconfig
sudo apt-get install ttf-dejavu

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