class Aws::MediaConvert::Types::CaptionDestinationSettings

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

@note When making an API call, you may pass CaptionDestinationSettings

data as a hash:

    {
      burnin_destination_settings: {
        alignment: "CENTERED", # accepts CENTERED, LEFT
        background_color: "NONE", # accepts NONE, BLACK, WHITE
        background_opacity: 1,
        font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
        font_opacity: 1,
        font_resolution: 1,
        font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
        font_size: 1,
        outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
        outline_size: 1,
        shadow_color: "NONE", # accepts NONE, BLACK, WHITE
        shadow_opacity: 1,
        shadow_x_offset: 1,
        shadow_y_offset: 1,
        teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
        x_position: 1,
        y_position: 1,
      },
      destination_type: "BURN_IN", # accepts BURN_IN, DVB_SUB, EMBEDDED, EMBEDDED_PLUS_SCTE20, IMSC, SCTE20_PLUS_EMBEDDED, SCC, SRT, SMI, TELETEXT, TTML, WEBVTT
      dvb_sub_destination_settings: {
        alignment: "CENTERED", # accepts CENTERED, LEFT
        background_color: "NONE", # accepts NONE, BLACK, WHITE
        background_opacity: 1,
        dds_handling: "NONE", # accepts NONE, SPECIFIED, NO_DISPLAY_WINDOW
        dds_x_coordinate: 1,
        dds_y_coordinate: 1,
        font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
        font_opacity: 1,
        font_resolution: 1,
        font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
        font_size: 1,
        height: 1,
        outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
        outline_size: 1,
        shadow_color: "NONE", # accepts NONE, BLACK, WHITE
        shadow_opacity: 1,
        shadow_x_offset: 1,
        shadow_y_offset: 1,
        subtitling_type: "HEARING_IMPAIRED", # accepts HEARING_IMPAIRED, STANDARD
        teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
        width: 1,
        x_position: 1,
        y_position: 1,
      },
      embedded_destination_settings: {
        destination_608_channel_number: 1,
        destination_708_service_number: 1,
      },
      imsc_destination_settings: {
        style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
      },
      scc_destination_settings: {
        framerate: "FRAMERATE_23_97", # accepts FRAMERATE_23_97, FRAMERATE_24, FRAMERATE_25, FRAMERATE_29_97_DROPFRAME, FRAMERATE_29_97_NON_DROPFRAME
      },
      srt_destination_settings: {
        style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
      },
      teletext_destination_settings: {
        page_number: "__stringMin3Max3Pattern1809aFAF09aEAE",
        page_types: ["PAGE_TYPE_INITIAL"], # accepts PAGE_TYPE_INITIAL, PAGE_TYPE_SUBTITLE, PAGE_TYPE_ADDL_INFO, PAGE_TYPE_PROGRAM_SCHEDULE, PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE
      },
      ttml_destination_settings: {
        style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
      },
      webvtt_destination_settings: {
        style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
      },
    }

@!attribute [rw] burnin_destination_settings

Settings related to burn-in 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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
BURN\_IN.
@return [Types::BurninDestinationSettings]

@!attribute [rw] destination_type

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
(SCTE20\_PLUS\_EMBEDDED). To create a non-compliant output where the
embedded captions come first, choose Embedded plus SCTE-20
(EMBEDDED\_PLUS\_SCTE20).
@return [String]

@!attribute [rw] dvb_sub_destination_settings

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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
DVB\_SUB.
@return [Types::DvbSubDestinationSettings]

@!attribute [rw] embedded_destination_settings

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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
EMBEDDED, EMBEDDED\_PLUS\_SCTE20, or SCTE20\_PLUS\_EMBEDDED.
@return [Types::EmbeddedDestinationSettings]

@!attribute [rw] imsc_destination_settings

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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
IMSC.
@return [Types::ImscDestinationSettings]

@!attribute [rw] scc_destination_settings

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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
SCC.
@return [Types::SccDestinationSettings]

@!attribute [rw] srt_destination_settings

SRT Destination Settings
@return [Types::SrtDestinationSettings]

@!attribute [rw] teletext_destination_settings

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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
TELETEXT.
@return [Types::TeletextDestinationSettings]

@!attribute [rw] ttml_destination_settings

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.
When you work directly in your JSON job specification, include this
object and any required children when you set destinationType to
TTML.
@return [Types::TtmlDestinationSettings]

@!attribute [rw] webvtt_destination_settings

WEBVTT Destination Settings
@return [Types::WebvttDestinationSettings]

@see docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/CaptionDestinationSettings AWS API Documentation

Constants

SENSITIVE