Class: Aws::MediaConvert::Types::CaptionDestinationSettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::MediaConvert::Types::CaptionDestinationSettings
- Defined in:
- gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb
Overview
When making an API call, you may pass CaptionDestinationSettings data as a hash:
{
burnin_destination_settings: {
alignment: "CENTERED", # accepts CENTERED, LEFT, AUTO
apply_font_color: "WHITE_TEXT_ONLY", # accepts WHITE_TEXT_ONLY, ALL_TEXT
background_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
background_opacity: 1,
fallback_font: "BEST_MATCH", # accepts BEST_MATCH, MONOSPACED_SANSSERIF, MONOSPACED_SERIF, PROPORTIONAL_SANSSERIF, PROPORTIONAL_SERIF
font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE, HEX, AUTO
font_opacity: 1,
font_resolution: 1,
font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
font_size: 1,
hex_font_color: "__stringMin6Max8Pattern09aFAF609aFAF2",
outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE, AUTO
outline_size: 1,
shadow_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
shadow_opacity: 1,
shadow_x_offset: 1,
shadow_y_offset: 1,
style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL, AUTO
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, AUTO
apply_font_color: "WHITE_TEXT_ONLY", # accepts WHITE_TEXT_ONLY, ALL_TEXT
background_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
background_opacity: 1,
dds_handling: "NONE", # accepts NONE, SPECIFIED, NO_DISPLAY_WINDOW
dds_x_coordinate: 1,
dds_y_coordinate: 1,
fallback_font: "BEST_MATCH", # accepts BEST_MATCH, MONOSPACED_SANSSERIF, MONOSPACED_SERIF, PROPORTIONAL_SANSSERIF, PROPORTIONAL_SERIF
font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE, HEX, AUTO
font_opacity: 1,
font_resolution: 1,
font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
font_size: 1,
height: 1,
hex_font_color: "__stringMin6Max8Pattern09aFAF609aFAF2",
outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE, AUTO
outline_size: 1,
shadow_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
shadow_opacity: 1,
shadow_x_offset: 1,
shadow_y_offset: 1,
style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
subtitling_type: "HEARING_IMPAIRED", # accepts HEARING_IMPAIRED, STANDARD
teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL, AUTO
width: 1,
x_position: 1,
y_position: 1,
},
embedded_destination_settings: {
destination_608_channel_number: 1,
destination_708_service_number: 1,
},
imsc_destination_settings: {
accessibility: "DISABLED", # accepts DISABLED, ENABLED
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: {
accessibility: "DISABLED", # accepts DISABLED, ENABLED
style_passthrough: "ENABLED", # accepts ENABLED, DISABLED, STRICT
},
}
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 https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#burnin_destination_settings ⇒ Types::BurninDestinationSettings
Burn-in is a captions delivery method, rather than a captions format.
-
#destination_type ⇒ String
Specify the format for this set of captions on this output.
-
#dvb_sub_destination_settings ⇒ Types::DvbSubDestinationSettings
Settings related to DVB-Sub captions.
-
#embedded_destination_settings ⇒ Types::EmbeddedDestinationSettings
Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions.
-
#imsc_destination_settings ⇒ Types::ImscDestinationSettings
Settings related to IMSC captions.
-
#scc_destination_settings ⇒ Types::SccDestinationSettings
Settings related to SCC captions.
-
#srt_destination_settings ⇒ Types::SrtDestinationSettings
Settings related to SRT captions.
-
#teletext_destination_settings ⇒ Types::TeletextDestinationSettings
Settings related to teletext captions.
-
#ttml_destination_settings ⇒ Types::TtmlDestinationSettings
Settings related to TTML captions.
-
#webvtt_destination_settings ⇒ Types::WebvttDestinationSettings
Settings related to WebVTT captions.
Instance Attribute Details
#burnin_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#destination_type ⇒ String
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).
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#dvb_sub_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#embedded_destination_settings ⇒ Types::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. 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.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#imsc_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#scc_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#srt_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#teletext_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#ttml_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |
#webvtt_destination_settings ⇒ Types::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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2592 class CaptionDestinationSettings < Struct.new( :burnin_destination_settings, :destination_type, :dvb_sub_destination_settings, :embedded_destination_settings, :imsc_destination_settings, :scc_destination_settings, :srt_destination_settings, :teletext_destination_settings, :ttml_destination_settings, :webvtt_destination_settings) SENSITIVE = [] include Aws::Structure end |