You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::MediaConvert::Types::CaptionDestinationSettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::MediaConvert::Types::CaptionDestinationSettings
- Defined in:
- (unknown)
Overview
When passing CaptionDestinationSettings as input to an Aws::Client method, you can use a vanilla 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,
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,
subtitling_type: "HEARING_IMPAIRED", # accepts HEARING_IMPAIRED, STANDARD
teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
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
},
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
},
}
Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.
Returned by:
Instance Attribute Summary collapse
-
#burnin_destination_settings ⇒ Types::BurninDestinationSettings
Burn-In Destination Settings.
-
#destination_type ⇒ String
Specify the format for this set of captions on this output.
-
#dvb_sub_destination_settings ⇒ Types::DvbSubDestinationSettings
DVB-Sub Destination Settings.
-
#embedded_destination_settings ⇒ Types::EmbeddedDestinationSettings
Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.
-
#imsc_destination_settings ⇒ Types::ImscDestinationSettings
Settings specific to IMSC caption outputs.
-
#scc_destination_settings ⇒ Types::SccDestinationSettings
Settings for SCC caption output.
-
#teletext_destination_settings ⇒ Types::TeletextDestinationSettings
Settings for Teletext caption output.
-
#ttml_destination_settings ⇒ Types::TtmlDestinationSettings
Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).
Instance Attribute Details
#burnin_destination_settings ⇒ Types::BurninDestinationSettings
Burn-In Destination Settings.
#destination_type ⇒ String
Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
Possible values:
- BURN_IN
- DVB_SUB
- EMBEDDED
- EMBEDDED_PLUS_SCTE20
- IMSC
- SCTE20_PLUS_EMBEDDED
- SCC
- SRT
- SMI
- TELETEXT
- TTML
- WEBVTT
#dvb_sub_destination_settings ⇒ Types::DvbSubDestinationSettings
DVB-Sub Destination Settings
#embedded_destination_settings ⇒ Types::EmbeddedDestinationSettings
Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.
#imsc_destination_settings ⇒ Types::ImscDestinationSettings
Settings specific to IMSC caption outputs.
#scc_destination_settings ⇒ Types::SccDestinationSettings
Settings for SCC caption output.
#teletext_destination_settings ⇒ Types::TeletextDestinationSettings
Settings for Teletext caption output
#ttml_destination_settings ⇒ Types::TtmlDestinationSettings
Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).