Skip to content

CaptionDestinationSettings

Source code in docs_src/capo_mediaconvert/types/caption_destination_settings.py
class CaptionDestinationSettings(TypedDict, closed=True):
    burnin_destination_settings: NotRequired[
        "capo_mediaconvert.types.burnin_destination_settings.BurninDestinationSettings"
    ]
    """Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html."""
    destination_type: NotRequired[
        "capo_mediaconvert.types.caption_destination_type.CaptionDestinationType"
    ]
    """Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20."""
    dvb_sub_destination_settings: NotRequired[
        "capo_mediaconvert.types.dvb_sub_destination_settings.DvbSubDestinationSettings"
    ]
    """Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html."""
    embedded_destination_settings: NotRequired[
        "capo_mediaconvert.types.embedded_destination_settings.EmbeddedDestinationSettings"
    ]
    """Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html."""
    imsc_destination_settings: NotRequired[
        "capo_mediaconvert.types.imsc_destination_settings.ImscDestinationSettings"
    ]
    """Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html."""
    scc_destination_settings: NotRequired[
        "capo_mediaconvert.types.scc_destination_settings.SccDestinationSettings"
    ]
    """Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html."""
    srt_destination_settings: NotRequired[
        "capo_mediaconvert.types.srt_destination_settings.SrtDestinationSettings"
    ]
    """Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video."""
    teletext_destination_settings: NotRequired[
        "capo_mediaconvert.types.teletext_destination_settings.TeletextDestinationSettings"
    ]
    """Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html."""
    ttml_destination_settings: NotRequired[
        "capo_mediaconvert.types.ttml_destination_settings.TtmlDestinationSettings"
    ]
    """Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html."""
    webvtt_destination_settings: NotRequired[
        "capo_mediaconvert.types.webvtt_destination_settings.WebvttDestinationSettings"
    ]
    """Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html."""

burnin_destination_settings instance-attribute

burnin_destination_settings: NotRequired[BurninDestinationSettings]

Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html.

destination_type instance-attribute

destination_type: NotRequired[CaptionDestinationType]

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20.

dvb_sub_destination_settings instance-attribute

dvb_sub_destination_settings: NotRequired[DvbSubDestinationSettings]

Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html.

embedded_destination_settings instance-attribute

embedded_destination_settings: NotRequired[EmbeddedDestinationSettings]

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html.

imsc_destination_settings instance-attribute

imsc_destination_settings: NotRequired[ImscDestinationSettings]

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html.

scc_destination_settings instance-attribute

scc_destination_settings: NotRequired[SccDestinationSettings]

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html.

srt_destination_settings instance-attribute

srt_destination_settings: NotRequired[SrtDestinationSettings]

Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video.

teletext_destination_settings instance-attribute

teletext_destination_settings: NotRequired[TeletextDestinationSettings]

Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html.

ttml_destination_settings instance-attribute

ttml_destination_settings: NotRequired[TtmlDestinationSettings]

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html.

webvtt_destination_settings instance-attribute

webvtt_destination_settings: NotRequired[WebvttDestinationSettings]

Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html.