Configuration

Here you can find the reference of all the settings that you can apply to the module by editing your Wowza application’s Application.xml file. You can create and edit these properties using the Wowza Streaming Engine Manager’s user interface as well. These properties have to go into the <Properties> section of your file as follows:

<?xml version="1.0" encoding="UTF-8"?>
<Root version="1">
 <Application>
  <Name>live</Name>
  <!-- trimmed -->
  <Properties>
   <Property>
    <Name>captionWordsPerMinute</Name>
    <Value>60</Value>
   </Property>
  </Properties>
 </Application>
</Root>

HttpProviderCaptionApi

captionOutputType

Defines the emitted caption types in the surrounding Wowza application. (ie open, closed or open,closed). Default value: open,closed.

captionTrafficLogEnabled

Log each incoming caption request for debugging purposes. Default: true. It is recommended to set it to false in production systems to prevent excessive logging.

ModuleOnTextDataToCEA608

captionWordsPerMinute

The default word per minute setting that determines the duration of captions if the caption request does not override it explicitly.

charsPerLine

The maximum number of characters per line in captions.

ccRepeatNumber

The number of repeated emissions for each CEA608 message. Default value: 1.

captionMergeEnabled

Controls the behaviour of subsequent and time-overlapping captions. If turned on (default), then lines gets merged and the module keeps track of the calculated expiration time per caption. The caption sent earlier is expected to expire earlier and afterwards only the latter captions(s) are visible, until they all expire. In extreme cases the expiration times could lead to reverse disappear order (e.g. long caption followed by a short one): the module extends the duration of the last caption to prevent this illogical visual effect.

If set to false, then any caption sent in will clear any previous caption immediately.

Default value: true

ModuleLiveOpenCaptions

captionOpenFontName

The name of the font used for rendering the open captions. Fonts can be installed to the standard locations recognized by the JVM and the operating system. Default value: SansSerif

captionOpenFontSize

The font size, default value if unspecified: 24

captionOpenFontStyle

The font style expressed as a numeric value. 0 means plain, 1 means bold, 2 means italic and 3 means bold italic.

captionOpenFontColor

The font color, defaults to white. You can use lowercase English font names: white, black, grey, etc.

captionOpenShadowColor

The color of the shadow, defaults to black.

captionOpenShadowSize

The size of the shadow dropped behind the text to improve readability. Default: 1

captionOpenBackgroundOpacity

The opacity of the background rectangle behind the caption between 0 and 100. 0 means opaque background. Default: 0

captionOpenBackgroundColor

The color of the background rectangle behind the caption. You can use lowercase English font names: white, black, grey, etc.

captionOpenAlignment

Text alignment. Possible values are: left, center

Default: center

captionOpenPositionX

Horizontal position of the text in pixels. Ignored with center aligment.

captionOpenPositionY

Vertical position of the text in pixels.

captionOpenAutoWrap

Controls the auto wrapping function of the module.

• on: line wraps in the caption itself are filtered out and the text is re-wrapped based on the specified line size

• both: long lines are wrapped, but incoming line breaks are respected

• off: only incoming line breaks are respected

The module treats \n or \n\r as line breaks, depending on the underlying operating system.

Default: on

captionOpenLineSize

The line length in characters used for wrapping. Default: 32

ModuleLiveTranscribe

audioSampleRate

The assumed audio sample rate of the input in Hz. Default: 48000

awsAccessKey

The access key to AWS.

awsRegion

The AWS region to use. Default region is that of the environment if unspecified.

awsSecretKey

The secret key to AWS

emitUnstableWords

If partial result stabilization is turned on, this flag determines whether words categorized as still unstable are emitted as captions or held back, until they become stable. Default: true

logTranscription

Controls whether transcription results are logged on info level. Default: false

partialResultsStability

Turns on stable partial results from AWS in exchange for delay. See https://docs.aws.amazon.com/transcribe/latest/dg/streaming-partial-results.html#streaming-partial-result-stabilization for details. Default: no value, which means the feature is turned off. Values: high, medium, low

transcribedStreamSuffix

The assumed suffix of the transcribed stream to which the captions should be emitted. Default: _aac

transcribeLanguageCode

Sets the language for the AWS Transcribe service. Default is auto-detection; currently supported values are “en-US”, “en-GB”, “es-US”, “fr-CA”, “fr-FR”, “en-AU”, “it-IT”, “de-DE”, “pt-BR”, ja-JP”, “ko-KR”, and “zh-CN”