Documentation

If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

See: newCaptionSourceSettings smart constructor.

Create a value of CaptionSourceSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ancillarySourceSettings:CaptionSourceSettings', captionSourceSettings_ancillarySourceSettings - Settings for ancillary captions source.

$sel:dvbSubSourceSettings:CaptionSourceSettings', captionSourceSettings_dvbSubSourceSettings - DVB Sub Source Settings

$sel:embeddedSourceSettings:CaptionSourceSettings', captionSourceSettings_embeddedSourceSettings - Settings for embedded captions Source

$sel:fileSourceSettings:CaptionSourceSettings', captionSourceSettings_fileSourceSettings - If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

$sel:sourceType:CaptionSourceSettings', captionSourceSettings_sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

$sel:teletextSourceSettings:CaptionSourceSettings', captionSourceSettings_teletextSourceSettings - Settings specific to Teletext caption sources, including Page number.

$sel:trackSourceSettings:CaptionSourceSettings', captionSourceSettings_trackSourceSettings - Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

$sel:webvttHlsSourceSettings:CaptionSourceSettings', captionSourceSettings_webvttHlsSourceSettings - Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Settings for ancillary captions source.

DVB Sub Source Settings

Settings for embedded captions Source

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Settings specific to Teletext caption sources, including Page number.

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.