Skip to content

CaptionSourceSettings

Source code in docs_src/capo_mediaconvert/types/caption_source_settings.py
class CaptionSourceSettings(TypedDict, closed=True):
    ancillary_source_settings: NotRequired[
        "capo_mediaconvert.types.ancillary_source_settings.AncillarySourceSettings"
    ]
    """Settings for ancillary captions source."""
    dvb_sub_source_settings: NotRequired[
        "capo_mediaconvert.types.dvb_sub_source_settings.DvbSubSourceSettings"
    ]
    """DVB Sub Source Settings"""
    embedded_source_settings: NotRequired[
        "capo_mediaconvert.types.embedded_source_settings.EmbeddedSourceSettings"
    ]
    """Settings for embedded captions Source"""
    file_source_settings: NotRequired[
        "capo_mediaconvert.types.file_source_settings.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."""
    source_type: NotRequired[
        "capo_mediaconvert.types.caption_source_type.CaptionSourceType"
    ]
    """Use Source to identify the format of your input captions. The service cannot auto-detect caption format."""
    teletext_source_settings: NotRequired[
        "capo_mediaconvert.types.teletext_source_settings.TeletextSourceSettings"
    ]
    """Settings specific to Teletext caption sources, including Page number."""
    track_source_settings: NotRequired[
        "capo_mediaconvert.types.track_source_settings.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."""
    webvtt_hls_source_settings: NotRequired[
        "capo_mediaconvert.types.webvtt_hls_source_settings.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."""

ancillary_source_settings instance-attribute

ancillary_source_settings: NotRequired[AncillarySourceSettings]

Settings for ancillary captions source.

dvb_sub_source_settings instance-attribute

dvb_sub_source_settings: NotRequired[DvbSubSourceSettings]

DVB Sub Source Settings

embedded_source_settings instance-attribute

embedded_source_settings: NotRequired[EmbeddedSourceSettings]

Settings for embedded captions Source

file_source_settings instance-attribute

file_source_settings: NotRequired[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.

source_type instance-attribute

source_type: NotRequired[CaptionSourceType]

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

teletext_source_settings instance-attribute

teletext_source_settings: NotRequired[TeletextSourceSettings]

Settings specific to Teletext caption sources, including Page number.

track_source_settings instance-attribute

track_source_settings: NotRequired[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.

webvtt_hls_source_settings instance-attribute

webvtt_hls_source_settings: NotRequired[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.