You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaLive::Types::CaptionDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass CaptionDescription data as a hash:

{
  caption_selector_name: "__string",
  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",
        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",
        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,
    },
    embedded_destination_settings: {
    },
    embedded_plus_scte_20_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: {
    },
  },
  language_code: "__string",
  language_description: "__string",
  name: "__string",
}

Output groups for this Live Event. Output groups contain information about where streams should be distributed.

Instance Attribute Summary collapse

Instance Attribute Details

#caption_selector_nameString

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

Returns:

  • (String)


1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1263

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name)
  include Aws::Structure
end

#destination_settingsTypes::CaptionDestinationSettings

Additional settings for captions destination that depend on the destination type.



1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1263

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name)
  include Aws::Structure
end

#language_codeString

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

Returns:

  • (String)


1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1263

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name)
  include Aws::Structure
end

#language_descriptionString

Human readable information to indicate captions available for players (eg. English, or Spanish).

Returns:

  • (String)


1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1263

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name)
  include Aws::Structure
end

#nameString

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Returns:

  • (String)


1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1263

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name)
  include Aws::Structure
end