Class: Aws::MediaLive::Types::CaptionDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::MediaLive::Types::CaptionDescription
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-medialive/types.rb
Overview
When making an API call, you may pass CaptionDescription data as a hash:
{
caption_selector_name: "__string", # required
destination_settings: {
arib_destination_settings: {
},
burn_in_destination_settings: {
alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
background_color: "BLACK", # accepts BLACK, NONE, WHITE
background_opacity: 1,
font: {
password_param: "__string",
uri: "__string", # required
username: "__string",
},
font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
font_opacity: 1,
font_resolution: 1,
font_size: "__string",
outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
outline_size: 1,
shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
shadow_opacity: 1,
shadow_x_offset: 1,
shadow_y_offset: 1,
teletext_grid_control: "FIXED", # accepts FIXED, SCALED
x_position: 1,
y_position: 1,
},
dvb_sub_destination_settings: {
alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
background_color: "BLACK", # accepts BLACK, NONE, WHITE
background_opacity: 1,
font: {
password_param: "__string",
uri: "__string", # required
username: "__string",
},
font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
font_opacity: 1,
font_resolution: 1,
font_size: "__string",
outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
outline_size: 1,
shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
shadow_opacity: 1,
shadow_x_offset: 1,
shadow_y_offset: 1,
teletext_grid_control: "FIXED", # accepts FIXED, SCALED
x_position: 1,
y_position: 1,
},
ebu_tt_d_destination_settings: {
copyright_holder: "__stringMax1000",
fill_line_gap: "DISABLED", # accepts DISABLED, ENABLED
font_family: "__string",
style_control: "EXCLUDE", # accepts EXCLUDE, INCLUDE
},
embedded_destination_settings: {
},
embedded_plus_scte_20_destination_settings: {
},
rtmp_caption_info_destination_settings: {
},
scte_20_plus_embedded_destination_settings: {
},
scte_27_destination_settings: {
},
smpte_tt_destination_settings: {
},
teletext_destination_settings: {
},
ttml_destination_settings: {
style_control: "PASSTHROUGH", # accepts PASSTHROUGH, USE_CONFIGURED
},
webvtt_destination_settings: {
style_control: "NO_STYLE_DATA", # accepts NO_STYLE_DATA, PASSTHROUGH
},
},
language_code: "__string",
language_description: "__string",
name: "__string", # required
}
Caption Description
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#caption_selector_name ⇒ String
Specifies which input caption selector to use as a caption source when generating output captions.
-
#destination_settings ⇒ Types::CaptionDestinationSettings
Additional settings for captions destination that depend on the destination type.
-
#language_code ⇒ String
ISO 639-2 three-digit code: www.loc.gov/standards/iso639-2/.
-
#language_description ⇒ String
Human readable information to indicate captions available for players (eg. English, or Spanish).
-
#name ⇒ String
Name of the caption description.
Instance Attribute Details
#caption_selector_name ⇒ String
Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
2454 2455 2456 2457 2458 2459 2460 2461 2462 |
# File 'lib/aws-sdk-medialive/types.rb', line 2454 class CaptionDescription < Struct.new( :caption_selector_name, :destination_settings, :language_code, :language_description, :name) SENSITIVE = [] include Aws::Structure end |
#destination_settings ⇒ Types::CaptionDestinationSettings
Additional settings for captions destination that depend on the destination type.
2454 2455 2456 2457 2458 2459 2460 2461 2462 |
# File 'lib/aws-sdk-medialive/types.rb', line 2454 class CaptionDescription < Struct.new( :caption_selector_name, :destination_settings, :language_code, :language_description, :name) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
ISO 639-2 three-digit code: www.loc.gov/standards/iso639-2/
2454 2455 2456 2457 2458 2459 2460 2461 2462 |
# File 'lib/aws-sdk-medialive/types.rb', line 2454 class CaptionDescription < Struct.new( :caption_selector_name, :destination_settings, :language_code, :language_description, :name) SENSITIVE = [] include Aws::Structure end |
#language_description ⇒ String
Human readable information to indicate captions available for players (eg. English, or Spanish).
2454 2455 2456 2457 2458 2459 2460 2461 2462 |
# File 'lib/aws-sdk-medialive/types.rb', line 2454 class CaptionDescription < Struct.new( :caption_selector_name, :destination_settings, :language_code, :language_description, :name) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
2454 2455 2456 2457 2458 2459 2460 2461 2462 |
# File 'lib/aws-sdk-medialive/types.rb', line 2454 class CaptionDescription < Struct.new( :caption_selector_name, :destination_settings, :language_code, :language_description, :name) SENSITIVE = [] include Aws::Structure end |