Package com.wowza.wms.timedtext.model

Interface ITimedTextConstants

public interface ITimedTextConstants

  • Field Details

    • TIMED_TEXT_TYPE_CAPTION

      static final String TIMED_TEXT_TYPE_CAPTION
      See Also:

    • SOURCE_TYPE_AMF

      static final String SOURCE_TYPE_AMF
      See Also:

    • SOURCE_TYPE_TTML

      static final String SOURCE_TYPE_TTML
      See Also:

    • SOURCE_TYPE_3GPP

      static final String SOURCE_TYPE_3GPP
      See Also:

    • SOURCE_TYPE_SRT

      static final String SOURCE_TYPE_SRT
      See Also:

    • SOURCE_TYPE_SCC

      static final String SOURCE_TYPE_SCC
      See Also:

    • SOURCE_TYPE_WEBVTT

      static final String SOURCE_TYPE_WEBVTT
      See Also:

    • OUTPUT_TYPE_CEA608

      static final String OUTPUT_TYPE_CEA608
      See Also:

    • OUTPUT_TYPE_AMF

      static final String OUTPUT_TYPE_AMF
      See Also:

    • OUTPUT_TYPE_TTML

      static final String OUTPUT_TYPE_TTML
      See Also:

    • AMF_TEXTTYPE_ON_TEXT_DATA

      static final String AMF_TEXTTYPE_ON_TEXT_DATA
      See Also:

    • LANGUAGE_LOCALE

      static final String LANGUAGE_LOCALE
      See Also:

    • LANGUAGE_ID_ENGLISH

      static final String LANGUAGE_ID_ENGLISH
      See Also:

    • PROP_VOD_CAPTIONS_ENABLED

      static final String PROP_VOD_CAPTIONS_ENABLED
      Timed Text Property "vodCaptionsEnabled": to enabled VOD captions for all supported protocols

      Type boolean. The default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled on a per protocol basis using PROP_CUPERTINO_VOD_CAPTIONS_ENABLED, PROP_RTMP_VOD_CAPTIONS_ENABLED, PROP_SANJOSE_VOD_CAPTIONS_ENABLED.

      See Also:

    • PROP_CUPERTINO_VOD_CAPTIONS_ENABLED

      static final String PROP_CUPERTINO_VOD_CAPTIONS_ENABLED
      Timed Text Property "cupertinoVODCaptionsEnabled": to enabled VOD captions for Cupertino streaming.

      Type boolean. The default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_VOD_CAPTIONS_ENABLED.

      See Also:

    • PROP_MPEGDASH_VOD_CAPTIONS_ENABLED

      static final String PROP_MPEGDASH_VOD_CAPTIONS_ENABLED
      Timed Text Property "mpegdashVODCaptionsEnabled": to enabled VOD captions for Cupertino streaming.

      Type boolean. The default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_VOD_CAPTIONS_ENABLED.

      See Also:

    • PROP_RTMP_VOD_CAPTIONS_ENABLED

      static final String PROP_RTMP_VOD_CAPTIONS_ENABLED
      Timed Text Property "rtmpVODCaptionsEnabled": to enabled VOD captions for RTMP streaming.

      Type boolean. The default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_VOD_CAPTIONS_ENABLED.

      See Also:

    • PROP_SANJOSE_VOD_CAPTIONS_ENABLED

      static final String PROP_SANJOSE_VOD_CAPTIONS_ENABLED
      Timed Text Property "sanJoseVODCaptionsEnabled": to enabled VOD captions for San Jose streaming.

      Type boolean. The default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_VOD_CAPTIONS_ENABLED.

      See Also:

    • PROP_CAPTION_LANGUAGES

      static final String PROP_CAPTION_LANGUAGES
      Timed Text Property "captionLanguages": used to select presented caption Language.

      Type String. The default is DEFAULT_PROPERTY_CAPTION_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Caption languages can be specified on a per protocol basis using PROP_CUPERTINO_CAPTION_LANGUAGES, PROP_RTMP_CAPTION_LANGUAGES, PROP_SANJOSE_CAPTION_LANGUAGES.

      See Also:

    • DEFAULT_PROPERTY_CAPTION_LANGUAGES

      static final String DEFAULT_PROPERTY_CAPTION_LANGUAGES
      Default value for Timed Text Property "captionLanguages".

      Default value is "*", meaning present all found languages.

      See Also:

    • DEFAULT_PROPERTY_CAPION_LANGUAGES

      static final String DEFAULT_PROPERTY_CAPION_LANGUAGES
      See Also:

    • PROP_CUPERTINO_CAPTION_LANGUAGES

      static final String PROP_CUPERTINO_CAPTION_LANGUAGES
      Timed Text Property "cupertinoCaptionLanguages": to enabled captionLanguage selection for Cupertino streaming.

      Type String. The default is DEFAULT_PROPERTY_CAPTION_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_CAPTION_LANGUAGES.

      See Also:

    • PROP_MPEGDASH_CAPTION_LANGUAGES

      static final String PROP_MPEGDASH_CAPTION_LANGUAGES
      Timed Text Property "mpegdashCaptionLanguages": to enabled captionLanguage selection for Cupertino streaming.

      Type String. The default is DEFAULT_PROPERTY_CAPTION_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_CAPTION_LANGUAGES.

      See Also:

    • PROP_RTMP_CAPTION_LANGUAGES

      static final String PROP_RTMP_CAPTION_LANGUAGES
      Timed Text Property "rtmpCaptionLanguages": to enabled captionLanguage selection for RTMP Type String. The default is DEFAULT_PROPERTY_CAPTION_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_CAPTION_LANGUAGES.

      See Also:

    • PROP_SANJOSE_CAPTION_LANGUAGES

      static final String PROP_SANJOSE_CAPTION_LANGUAGES
      Timed Text Property "sanJoseCaptionLanguages": to enabled captionLanguage selection for San Jose streaming.

      Type String. The default is DEFAULT_PROPERTY_CAPTION_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      VOD Captions can be enabled for all protocols using PROP_CAPTION_LANGUAGES.

      See Also:

    • PROP_DEBUG_VOD_CAPTION_LANGUAGE_SELECTION

      static final String PROP_DEBUG_VOD_CAPTION_LANGUAGE_SELECTION
      Timed Text Property "debugVODCaptionLanguageSelection": adds info level logging regarding language selection

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      Can be enabled on a per protocol basis using PROP_DEBUG_CUPERTINO_VOD_CAPTION_LANGUAGE_SELECTION, PROP_DEBUG_RTMP_VOD_CAPTION_LANGUAGE_SELECTION, PROP_DEBUG_SANJOSE_VOD_CAPTION_LANGUAGE_SELECTION.

      See Also:

    • PROP_DEBUG_CUPERTINO_VOD_CAPTION_LANGUAGE_SELECTION

      static final String PROP_DEBUG_CUPERTINO_VOD_CAPTION_LANGUAGE_SELECTION
      Timed Text Property "cupertinoDebugVODCaptionLanguageSelection": adds info level logging regarding language selection for Cupertino Streaming

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_MPEGDASH_VOD_CAPTION_LANGUAGE_SELECTION

      static final String PROP_DEBUG_MPEGDASH_VOD_CAPTION_LANGUAGE_SELECTION
      Timed Text Property "mpegdashDebugVODCaptionLanguageSelection": adds info level logging regarding language selection for Cupertino Streaming

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_RTMP_VOD_CAPTION_LANGUAGE_SELECTION

      static final String PROP_DEBUG_RTMP_VOD_CAPTION_LANGUAGE_SELECTION
      Timed Text Property "rtmpDebugVODCaptionLanguageSelection": adds info level logging regarding language selection for RTMP Streaming

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SANJOSE_VOD_CAPTION_LANGUAGE_SELECTION

      static final String PROP_DEBUG_SANJOSE_VOD_CAPTION_LANGUAGE_SELECTION
      Timed Text Property "sanJoseDebugVODCaptionLanguageSelection": adds info level logging regarding language selection for San Jose Streaming

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_VOD_CAPTION_PROVIDER_DETERMINATION

      static final String PROP_DEBUG_VOD_CAPTION_PROVIDER_DETERMINATION
      Timed Text Property "debugVODCaptionProviderDetermination": adds info level logging regarding caption provider determination for a given VOD asset

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      Can be enabled on a per protocol basis using PROP_DEBUG_CUPERTINO_VOD_CAPTION_PROVIDER_DETERMINATION, PROP_DEBUG_RTMP_VOD_CAPTION_PROVIDER_DETERMINATION, PROP_DEBUG_SANJOSE_VOD_CAPTION_PROVIDER_DETERMINATION.

      See Also:

    • PROP_DEBUG_CUPERTINO_VOD_CAPTION_PROVIDER_DETERMINATION

      static final String PROP_DEBUG_CUPERTINO_VOD_CAPTION_PROVIDER_DETERMINATION
      Timed Text Property "cupertinoDebugVODCaptionProviderDetermination": adds info level logging regarding caption provider determination for a given VOD asset for Cupertino Streaming.

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_MPEGDASH_VOD_CAPTION_PROVIDER_DETERMINATION

      static final String PROP_DEBUG_MPEGDASH_VOD_CAPTION_PROVIDER_DETERMINATION
      Timed Text Property "mpegdashDebugVODCaptionProviderDetermination": adds info level logging regarding caption provider determination for a given VOD asset for MPEGDash Streaming.

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_RTMP_VOD_CAPTION_PROVIDER_DETERMINATION

      static final String PROP_DEBUG_RTMP_VOD_CAPTION_PROVIDER_DETERMINATION
      Timed Text Property "rtmpDebugVODCaptionProviderDetermination": adds info level logging regarding caption provider determination for a given VOD asset for RTMP Streaming.

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SANJOSE_VOD_CAPTION_PROVIDER_DETERMINATION

      static final String PROP_DEBUG_SANJOSE_VOD_CAPTION_PROVIDER_DETERMINATION
      Timed Text Property "sanJoseVODDebugCaptionProviderDetermination": adds info level logging regarding caption provider determination for a given VOD asset for San Jose Streaming.

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_VOD_CAPTION_COMPANION_FILES

      static final String PROP_DEBUG_VOD_CAPTION_COMPANION_FILES
      Timed Text Property "debugVODCaptionFileDetermination": adds info level logging regarding caption companion file determination for a given VOD asset

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      Can be enabled on a per provider basis as well using PROP_DEBUG_TTML_VOD_CAPTION_COMPANION_FILES

      See Also:

    • PROP_UNDEFINED_LANG_CODE

      static final String PROP_UNDEFINED_LANG_CODE
      Timed Text Property "captionUndefinedLanguageId": if incoming caption language is undefined, use this language ID.

      Type String. If not defined, the Locale's 3 character language code is used. See Locale.getDefault().getISO3Language()

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CAPTION_FILE_NAMING_RULE

      static final String PROP_CAPTION_FILE_NAMING_RULE
      Timed Text Property "captionFileNamingRule": to change logic determining the caption companion file naming scheme

      Type String. The default value is DEFAULT_PROPERTY_CAPTION_FILE_NAMING_RULE.

      This string is used to find the caption file for a given VOD asset. It is used in conjunction with PROP_CAPTION_PATH_NAMING_RULE, which determines the file location.

      It is comprised of variables preceded by a dollar sign and enclosed in squiggly brackets. For example: "${var1}.{var2}"

      Valid variables include these:

      • ${SourceStreamName} : The baseName of the VOD file
      • ${SourceBasePath} : The base path of the VOD asset
      • ${FileExtension} : Registered file extensions with the Timed Text Provider
      and these standard ones:
      • ${com.wowza.wms.context.VHost}
      • ${com.wowza.wms.context.VHostConfigHome", appInstance.getVHost().getHomePath()};
      • ${com.wowza.wms.context.Application", appInstance.getApplication().getName()};
      • ${com.wowza.wms.context.ApplicationInstance", appInstance.getName()};

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • DEFAULT_PROPERTY_CAPTION_FILE_NAMING_RULE

      static final String DEFAULT_PROPERTY_CAPTION_FILE_NAMING_RULE
      Default value for Timed Text Property "captionFileNamingRule".

      Default value is "${SourceStreamName}.${FileExtension}"

      See Also:

    • PROP_CAPTION_PATH_NAMING_RULE

      static final String PROP_CAPTION_PATH_NAMING_RULE
      Timed Text Property "captionPathNamingRule": to change logic determining the caption companion path

      Type String. The default value is DEFAULT_PROPERTY_CAPTION_PATH_NAMING_RULE.

      This string is used to find the caption file location for a given VOD asset. It is used in conjunction with PROP_CAPTION_FILE_NAMING_RULE, which determines the file name.

      It is comprised of variables preceded by a dollar sign and enclosed in squiggly brackets. For example: "${var1}.{var2}"

      Valid variables include these:

      • ${SourceStreamName} : The baseName of the VOD file
      • ${SourceBasePath} : The base path of the VOD asset
      • ${FileExtension} : Registered file extensions with the Timed Text Provider
      and these standard ones:
      • ${com.wowza.wms.context.VHost}
      • ${com.wowza.wms.context.VHostConfigHome", appInstance.getVHost().getHomePath()};
      • ${com.wowza.wms.context.Application", appInstance.getApplication().getName()};
      • ${com.wowza.wms.context.ApplicationInstance", appInstance.getName()};

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • DEFAULT_PROPERTY_CAPTION_PATH_NAMING_RULE

      static final String DEFAULT_PROPERTY_CAPTION_PATH_NAMING_RULE
      Default value for Timed Text Property "captionFileNamingRule". Default value is "${SourceBasePath}"
      See Also:

    • PROP_MAXIMUM_CAPTION_DURATION

      static final String PROP_MAXIMUM_CAPTION_DURATION
      Timed Text Property "maximumCaptionDuration": used to determine maximum caption duration

      Type Integer. In ms. The default is DEFAULT_MAXIMUM_CAPTION_DURATION

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • DEFAULT_MAXIMUM_CAPTION_DURATION

      static final int DEFAULT_MAXIMUM_CAPTION_DURATION
      Default value for Timed Text Property "maximumCaptionDuration".

      Default value is 10000.

      See Also:

    • PROP_CAPTION_CHARACTER_SET

      static final String PROP_CAPTION_CHARACTER_SET
      Timed Text Property "captionCharacterSet": used to determine character set when ingesting captions

      Type String. The default is DEFAULT_CAPTION_CHARACTER_SET

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • DEFAULT_CAPTION_CHARACTER_SET

      static final String DEFAULT_CAPTION_CHARACTER_SET
      Default value for Timed Text Property "captionCharacterSet".

      Default value is "UTF-8"

      See Also:

    • PROP_SRT_CAPTION_CHARACTER_SET

      static final String PROP_SRT_CAPTION_CHARACTER_SET
      Timed Text Property "srtReaderCaptionCharacterSet": used to determine character set when ingesting SRT captions Overrides general property "captionCharacterSet"

      Type String. The default is DEFAULT_CAPTION_CHARACTER_SET

      See Also:

    • PROP_TTML_CAPTION_CHARACTER_SET

      static final String PROP_TTML_CAPTION_CHARACTER_SET
      Timed Text Property "ttmlReaderCaptionCharacterSet": used to determine character set when ingesting TTML captions Overrides general property "captionCharacterSet"

      Type String. The default is DEFAULT_CAPTION_CHARACTER_SET

      See Also:

    • PROP_3GPP_CAPTION_CHARACTER_SET

      static final String PROP_3GPP_CAPTION_CHARACTER_SET
      Timed Text Property "reader3GPPCaptionCharacterSet": used to determine character set when ingesting TTML captions Overrides general property "captionCharacterSet"

      Type String. The default is DEFAULT_CAPTION_CHARACTER_SET

      See Also:

    • PROP_CEA608_CONVERTER_COLOR

      static final String PROP_CEA608_CONVERTER_COLOR
      Timed Text Property "cea608CaptionConverterColor": color of text in default CEA caption converter.

      Type Integer. Default is ClosedCaptionCEA608Utils.COL0_WHITE

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CEA608_CONVERTER_CHARS_PER_LINE

      static final String PROP_CEA608_CONVERTER_CHARS_PER_LINE
      Timed Text Property "cea608CaptionConverterCharsPerLine": max number characters per line in default CEA caption converter.

      Type Integer. Default is ClosedCaptionCEA608Utils.COUNT_COLS

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CEA608_CONVERTER_CHARACTER_SET

      static final String PROP_CEA608_CONVERTER_CHARACTER_SET
      Timed Text Property "cea608CaptionConverterCharacterSet":character set in default CEA caption converter.

      Type String. Default is "UTF-8"

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CUPERTINO_VOD_REMOVE_EXISTING_CEA608

      static final String PROP_CUPERTINO_VOD_REMOVE_EXISTING_CEA608
      Timed Text Property "cupertinoVODCaptionsRemoveExistingCEA608": if existing VOD has 608, remove them

      Type Boolean. Default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CUPERTINO_VOD_USE_WEBVTT

      static final String PROP_CUPERTINO_VOD_USE_WEBVTT
      Timed Text Property "cupertinoVODCaptionsUseWebVTT"

      Type Boolean. Default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CUPERTINO_LIVE_USE_WEBVTT

      static final String PROP_CUPERTINO_LIVE_USE_WEBVTT
      Timed Text Property "cupertinoLiveCaptionsUseWebVTT"

      Type Boolean. Default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_CUPERTINO_LIVE_WEBVTT_ADD_SPECIAL_EMPTY_CAPTION

      static final String PROP_CUPERTINO_LIVE_WEBVTT_ADD_SPECIAL_EMPTY_CAPTION
      Timed Text Property "cupertinoLiveWebVTTAddSpecialEmptyCaption"

      Type Boolean. Default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_AMF_CONVERTER_TEXT_TYPE

      static final String PROP_AMF_CONVERTER_TEXT_TYPE
      Timed Text Property "amfCaptionConverterTextType":AMF text type used in conversion

      Type String. Default is AMF_TEXTTYPE_ON_TEXT_DATA

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • DEFAULT_AMF_CONVERTER_TEXT_TYPE

      static final String DEFAULT_AMF_CONVERTER_TEXT_TYPE
      See Also:

    • PROP_AMF_CONVERTER_TRACK_INDEX

      static final String PROP_AMF_CONVERTER_TRACK_INDEX
      Timed Text Property "amfCaptionConverterTrackIndex": track index used for captions

      Type Integer.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • DEFAULT_AMF_CONVERTER_TRACK_INDEX

      static final int DEFAULT_AMF_CONVERTER_TRACK_INDEX
      See Also:

    • PROP_AMF_CONVERTER_INSERT_ERASES_IN_GAPS

      static final String PROP_AMF_CONVERTER_INSERT_ERASES_IN_GAPS
      Timed Text Property "amfCaptionConverterInsertErases": insert erase captions if gaps between captions are greater than PROP_MAXIMUM_CAPTION_DURATION

      Type boolean. The default is true.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_WEBVTT_CONVERTER_INSERT_ERASES_IN_GAPS

      static final String PROP_WEBVTT_CONVERTER_INSERT_ERASES_IN_GAPS
      Timed Text Property "webVTTCaptionConverterInsertErases": insert erase captions if gaps between captions are greater than PROP_MAXIMUM_CAPTION_DURATION

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_TTML_VOD_CAPTION_COMPANION_FILES

      static final String PROP_DEBUG_TTML_VOD_CAPTION_COMPANION_FILES
      Timed Text Property "debugTTMLVODCaptionFileDetermination": adds info level logging regarding caption companion file determination for a given VOD asset for TTML Streaming.

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_TTML_CAPTION_PARSER

      static final String PROP_DEBUG_TTML_CAPTION_PARSER
      Timed Text Property "debugTTMLCaptionParser": adds info level logging regarding the TTML caption parser

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_TTML_CAPTION_PARSER_TIME

      static final String PROP_DEBUG_TTML_CAPTION_PARSER_TIME
      Timed Text Property "debugTTMLCaptionParserTime": adds info level logging regarding how long it took parser to index

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_TTML_INLINE_TAGS_IN_TEXT

      static final String PROP_TTML_INLINE_TAGS_IN_TEXT
      Timed Text Property "ttmlInlineTagsInText": TTML parser includes in-line styling and line-break tags in the sample text

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      Example sample: "

      I can linebreak
      or change fontWeight to <span tts:fontWeight="bold">bold in the middle of a sample.

      " If ttmlInlineTagsInText=true then the parser provides the sample text as: "I can linebreak
      or change fontWeight to <span tts:fontWeight="bold">bold in the middle of a sample." If ttmlInlineTagsInText=false then the parser provides the sample text as: "I can linebreak or change fontWeight to bold in the middle of a sample."

      See Also:

    • PROP_DEBUG_SRT_VOD_CAPTION_COMPANION_FILES

      static final String PROP_DEBUG_SRT_VOD_CAPTION_COMPANION_FILES
      Timed Text Property "debugSRTVODCaptionFileDetermination": adds info level logging regarding caption companion file determination for a given VOD asset for SRT provider

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SRT_CAPTION_PARSER

      static final String PROP_DEBUG_SRT_CAPTION_PARSER
      Timed Text Property "debugSRTCaptionParser": adds info level logging regarding the SRT caption parser

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SRT_CAPTION_PARSER_TIME

      static final String PROP_DEBUG_SRT_CAPTION_PARSER_TIME
      Timed Text Property "debugSRTCaptionParserTime": adds info level logging regarding how long it took parser to index

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_WEBVTT_VOD_CAPTION_COMPANION_FILES

      static final String PROP_DEBUG_WEBVTT_VOD_CAPTION_COMPANION_FILES
      Timed Text Property "debugWebVTTVODCaptionFileDetermination": adds info level logging regarding caption companion file determination for a given VOD asset for WebVTT provider

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_WEBVTT_CAPTION_PARSER

      static final String PROP_DEBUG_WEBVTT_CAPTION_PARSER
      Timed Text Property "debugWebVTTCaptionParser": adds info level logging regarding the WebVTT caption parser

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_WEBVTT_CAPTION_PARSER_TIME

      static final String PROP_DEBUG_WEBVTT_CAPTION_PARSER_TIME
      Timed Text Property "debugWebVTTCaptionParserTime": adds info level logging regarding how long it took parser to index

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SCC_VOD_CAPTION_COMPANION_FILES

      static final String PROP_DEBUG_SCC_VOD_CAPTION_COMPANION_FILES
      Timed Text Property "debugSCCVODCaptionFileDetermination": adds info level logging regarding caption companion file determination for a given VOD asset for SCC provider

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SCC_CAPTION_PARSER

      static final String PROP_DEBUG_SCC_CAPTION_PARSER
      Timed Text Property "debugSCCCaptionParser": adds info level logging regarding the SCC caption parser

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_SCC_CAPTION_PARSER_TIME

      static final String PROP_DEBUG_SCC_CAPTION_PARSER_TIME
      Timed Text Property "debugSCCCaptionParserTime": adds info level logging regarding how long it took parser to index

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_3GPP_CAPTION_PARSER

      static final String PROP_DEBUG_3GPP_CAPTION_PARSER
      Timed Text Property "debug3GPPCaptionParser": adds info level logging regarding the 3GPP parser

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_3GPP_CAPTION_PARSER_TIME

      static final String PROP_DEBUG_3GPP_CAPTION_PARSER_TIME
      Timed Text Property "debug3GPPCaptionParserTime": adds info level logging regarding how long it took parser to index

      Type boolean. The default is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • QUERYSTR_CAPTIONLANGUAGES

      static final String QUERYSTR_CAPTIONLANGUAGES
      Query string used for choosing caption languages. Language must be presented using ISO 3 letter language codes.
      See Also:

    • PROP_CAPTION_LANGUAGE_QUERY_PARAMETER

      static final String PROP_CAPTION_LANGUAGE_QUERY_PARAMETER
      HTTP Streamer Property "captionLanguageQueryParameter": used for changing query string param used for caption language selection. Note: Must go into HTTPStreamers.xml under Properties for each streamer type

      Type String. The default is "wowzacaptionlanguages"

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • QUERYSTR_CAPTION_FILENAME

      static final String QUERYSTR_CAPTION_FILENAME
      Query string used for choosing caption languages. Language must be presented using ISO 3 letter language codes.
      See Also:

    • PROP_CAPTION_FILENAME_QUERY_PARAMETER

      static final String PROP_CAPTION_FILENAME_QUERY_PARAMETER
      HTTP Streamer Property "captionFilenameQueryParameter": used for changing query string param used for caption file selection. Note: Must go into HTTPStreamers.xml under Properties for each streamer type

      Type String. The default is "wowzacaptionfile"

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_AMF_ID_STRING

      static final String PROP_LIVE_CAPTION_INGEST_AMF_ID_STRING
      Timed Text Property "captionLiveIngestAMFIDString": to change AMF identifier from default "onTextData" to something else

      Type String. The default value is "onTextData".

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_USE_STREAM_NAME_GROUPS

      static final String PROP_LIVE_CAPTION_USE_STREAM_NAME_GROUPS
      Timed Text Property "captionLiveIngestUseStreamNameGroups": to enable use of smil files to determine available languages and ingest type

      Type Boolean. The default value is true. Only affects streams started with .smil files using StartupStreams or stream manager.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_DEFAULT_LANGUAGES

      static final String PROP_LIVE_CAPTION_DEFAULT_LANGUAGES
      Timed Text Property "captionLiveIngestLanguages": comma separated ISO-639 language codes determining what languages are expected in the live stream

      Type String. The default value is the language returned by Locale.getDefault().getISO3Language().

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_TYPE

      static final String PROP_LIVE_CAPTION_INGEST_TYPE
      Timed Text Property "captionLiveIngestType": type of live caption ingestion.

      This corresponds to LiveIngestTypes in TimedTextProviders.

      Type String. The default value is "onTextData". "onCaption" is also a valid value. "CEA608" is a valid value since 4.0.4

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_LIVE_CAPTION_INGEST

      static final String PROP_DEBUG_LIVE_CAPTION_INGEST
      Timed Text Property "debugCaptionLiveIngest"

      Type Boolean. The default value is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_LIVE_CAPTION_ONTEXTDATA_INGEST

      static final String PROP_DEBUG_LIVE_CAPTION_ONTEXTDATA_INGEST
      Timed Text Property "debugCaptionLiveOnTextDataIngest"

      Type Boolean. The default value is false. Overrides PROP_LIVE_CAPTION_DEFAULT_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_LIVE_CAPTION_ONCAPTION_INGEST

      static final String PROP_DEBUG_LIVE_CAPTION_ONCAPTION_INGEST
      Timed Text Property "debugCaptionLiveOnCaptionIngest"

      Type Boolean. The default value is false. Overrides PROP_LIVE_CAPTION_DEFAULT_LANGUAGES

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_STRING

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_STRING
      Timed Text Property "captionLiveIngestOnCaptionString": to change AMF identifier from default "onCaption" to something else

      Type String. The default value is "onCaption".

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_INFO_STRING

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_INFO_STRING
      Timed Text Property "captionLiveIngestOnCaptionInfoString": to change AMF identifier from default "onCaptionInfo" to something else

      Type String. The default value is "onCaptionInfo".

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_IDLE_TIME_TO_FLUSH_DECODER

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_IDLE_TIME_TO_FLUSH_DECODER
      Timed Text Property "captionLiveIngestOnCaptionCEA608IdleTimeToFlushDecoder" Controls allowed amount of idle time when parsing CEA-608 captions when ingested from AMF 708 data events

      Type Integer. The default value is 250 ms.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_ENABLE_FIELD1

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_ENABLE_FIELD1
      Timed Text Property "captionLiveIngestOnCaptionCEA608EnableField2": When ingesting AMF onCaption 708 data events (actually CEA-608), controls whether CEA-608 field 1 is enabled for decoding

      Type Boolean. Default is true;

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_ENABLE_FIELD2

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_ENABLE_FIELD2
      Timed Text Property "captionLiveIngestOnCaptionCEA608EnableField2": When ingesting AMF onCaption 708 data events (actually CEA-608), controls whether CEA-608 field 2 is enabled for decoding

      Type Boolean. Default is false;

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_MAX_WARN_MESSAGES

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_MAX_WARN_MESSAGES
      Timed Text Property "captionLiveIngestOnCaptionCEA608MaxWarnMessages": When ingesting AMF onCaption 708 data events (actually CEA-608), controls the maximum number of warning messages that are logged by the decoder

      Type Integer. Default is 25.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_TRACK_NUMBER

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_TRACK_NUMBER
      Timed Text Property "captionLiveIngestOnCaptionCEA608TrackNumber": When ingesting AMF onCaption 708 data events (actually CEA-608), controls the track number used to add captions as onTextData

      Type Integer. Default is 99.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_LANGUAGE_ID

      static final String PROP_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_LANGUAGE_ID
      Timed Text Property "captionLiveIngestOnCaptionCEA608LanguageID": When ingesting AMF onCaption 708 data events (actually CEA-608), controls the language ID used to add captions as onTextData

      Type String. Default is language code of Java's locale.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_VERBOSE

      static final String PROP_DEBUG_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_VERBOSE
      Timed Text Property "debugCaptionLiveIngestOnCaptionCEA608Verbose" : Adds verbose logging to AMF onCaption events of type "708" (CEA-608)

      Type Boolean. The default value is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_LOG_AS_SCC

      static final String PROP_DEBUG_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_LOG_AS_SCC
      Timed Text Property "debugCaptionLiveIngestOnCaptionCEA608LogAsSCC" : Adds additional logging of decoding AMF onCaption events of type "708" (CEA-608) such that they are logged in SCC format

      Type Boolean. The default value is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • PROP_DEBUG_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_LOG_AS_RAW

      static final String PROP_DEBUG_LIVE_CAPTION_INGEST_ON_CAPTION_CEA608_LOG_AS_RAW
      Timed Text Property "debugCaptionLiveIngestOnCaptionCEA608LogAsRaw" : Adds additional logging of decoding AMF onCaption events of type "708" (CEA-608) such that they are logged in a raw binary state

      Type Boolean. The default value is false.

      Add the property to Application/TimedText/Properties in Application.xml

      See Also:

    • ON_TEXT_DATA

      static final String ON_TEXT_DATA
      See Also:

    • ON_CAPTION_INFO

      static final String ON_CAPTION_INFO
      See Also:

    • ON_CAPTION

      static final String ON_CAPTION
      See Also:

    • CEA608

      static final String CEA608
      See Also:

    • SMIL_PARAM_WOWZA_CAPTION_INGEST_TYPE

      static final String SMIL_PARAM_WOWZA_CAPTION_INGEST_TYPE
      See Also:

    • SMIL_PARAM_IS_WOWZA_CAPTION_STREAM

      static final String SMIL_PARAM_IS_WOWZA_CAPTION_STREAM
      See Also:

    • PROP_CUPERTINO_VOD_CAPTIONS_DELEGATE_CLASS

      static final String PROP_CUPERTINO_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • DEFAULT_PROPERTY_CUPERTINO_VOD_CAPTIONS_DELEGATE_CLASS

      static final String DEFAULT_PROPERTY_CUPERTINO_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • PROP_MPEGDASH_VOD_CAPTIONS_DELEGATE_CLASS

      static final String PROP_MPEGDASH_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • DEFAULT_PROPERTY_MPEGDASH_VOD_CAPTIONS_DELEGATE_CLASS

      static final String DEFAULT_PROPERTY_MPEGDASH_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • PROP_RTMP_VOD_CAPTIONS_DELEGATE_CLASS

      static final String PROP_RTMP_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • DEFAULT_PROPERTY_RTMP_VOD_CAPTIONS_DELEGATE_CLASS

      static final String DEFAULT_PROPERTY_RTMP_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • PROP_SANJOSE_VOD_CAPTIONS_DELEGATE_CLASS

      static final String PROP_SANJOSE_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • DEFAULT_PROPERTY_SANJOSE_VOD_CAPTIONS_DELEGATE_CLASS

      static final String DEFAULT_PROPERTY_SANJOSE_VOD_CAPTIONS_DELEGATE_CLASS
      See Also:

    • PROP_CEA608_CONVERTER_CLASS

      static final String PROP_CEA608_CONVERTER_CLASS
      See Also:

    • DEFAULT_CEA608_CONVERTER_CLASS

      static final String DEFAULT_CEA608_CONVERTER_CLASS
      See Also:

    • DEFAULT_CEA608_IDENTITY_CONVERTER_CLASS

      static final String DEFAULT_CEA608_IDENTITY_CONVERTER_CLASS
      See Also:

    • PROP_TTML_TO_CEA608_CONVERTER_CLASS

      static final String PROP_TTML_TO_CEA608_CONVERTER_CLASS
      See Also:

    • PROP_MP4_TO_CEA608_CONVERTER_CLASS

      static final String PROP_MP4_TO_CEA608_CONVERTER_CLASS
      See Also:

    • PROP_SRT_TO_CEA608_CONVERTER_CLASS

      static final String PROP_SRT_TO_CEA608_CONVERTER_CLASS
      See Also:

    • PROP_WEBVTT_TO_CEA608_CONVERTER_CLASS

      static final String PROP_WEBVTT_TO_CEA608_CONVERTER_CLASS
      See Also:

    • PROP_SCC_TO_CEA608_CONVERTER_CLASS

      static final String PROP_SCC_TO_CEA608_CONVERTER_CLASS
      See Also:

    • PROP_CEA608_MAX_COMMANDS_PER_FRAME

      static final String PROP_CEA608_MAX_COMMANDS_PER_FRAME
      See Also:

    • PROP_AMF_CONVERTER_CLASS

      static final String PROP_AMF_CONVERTER_CLASS
      See Also:

    • DEFAULT_AMF_CONVERTER_CLASS

      static final String DEFAULT_AMF_CONVERTER_CLASS
      See Also:

    • PROP_TTML_TO_AMF_CONVERTER_CLASS

      static final String PROP_TTML_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_SCC_TO_AMF_CONVERTER_CLASS

      static final String PROP_SCC_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_MP4_TO_AMF_CONVERTER_CLASS

      static final String PROP_MP4_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_SRT_TO_AMF_CONVERTER_CLASS

      static final String PROP_SRT_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_WEBVTT_TO_AMF_CONVERTER_CLASS

      static final String PROP_WEBVTT_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_LIVE_ONTEXTDATA_TO_AMF_CONVERTER_CLASS

      static final String PROP_LIVE_ONTEXTDATA_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_LIVE_ONCAPTION_TO_AMF_CONVERTER_CLASS

      static final String PROP_LIVE_ONCAPTION_TO_AMF_CONVERTER_CLASS
      See Also:

    • PROP_WEBVTT_CONVERTER_CLASS

      static final String PROP_WEBVTT_CONVERTER_CLASS
      See Also:

    • DEFAULT_WEBVTT_CONVERTER_CLASS

      static final String DEFAULT_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_TTML_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_TTML_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_SCC_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_SCC_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_MP4_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_MP4_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_SRT_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_SRT_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_WEBVTT_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_WEBVTT_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_LIVE_ONTEXTDATA_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_LIVE_ONTEXTDATA_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROP_LIVE_ONCAPTION_TO_WEBVTT_CONVERTER_CLASS

      static final String PROP_LIVE_ONCAPTION_TO_WEBVTT_CONVERTER_CLASS
      See Also:

    • PROPERTY_SOURCE_DURATION

      static final String PROPERTY_SOURCE_DURATION
      See Also:

    • PROPERTY_SOURCE_TIME_SCALE

      static final String PROPERTY_SOURCE_TIME_SCALE
      See Also:

    • PROPERTY_SOURCE_TRACK_INDEX

      static final String PROPERTY_SOURCE_TRACK_INDEX
      See Also:

    • TIMED_TEXT_READER_EXTENSION_TTML

      static final String TIMED_TEXT_READER_EXTENSION_TTML
      See Also:

    • TIMED_TEXT_READER_EXTENSION_SRT

      static final String TIMED_TEXT_READER_EXTENSION_SRT
      See Also:

    • TIMED_TEXT_READER_EXTENSION_SCC

      static final String TIMED_TEXT_READER_EXTENSION_SCC
      See Also:

    • TIMED_TEXT_READER_EXTENSION_WEBVTT

      static final String TIMED_TEXT_READER_EXTENSION_WEBVTT
      See Also:

    • DEFAULT_TIMED_TEXT_READER_SCC

      static final String DEFAULT_TIMED_TEXT_READER_SCC
      See Also:

    • DEFAULT_TIMED_TEXT_READER_SRT

      static final String DEFAULT_TIMED_TEXT_READER_SRT
      See Also:

    • DEFAULT_TIMED_TEXT_READER_TTML

      static final String DEFAULT_TIMED_TEXT_READER_TTML
      See Also:

    • DEFAULT_TIMED_TEXT_READER_WEBVTT

      static final String DEFAULT_TIMED_TEXT_READER_WEBVTT
      See Also: