AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CaptionDescription as input to an Aws::Client method, you can use a vanilla 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: {
      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: {
    },
  },
  language_code: "__string",
  language_description: "__string",
  name: "__string", # required
}

Caption Description

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)

    Specifies which input caption selector to use as a caption source when generating output captions.

#destination_settingsTypes::CaptionDestinationSettings

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

Returns:

#language_codeString

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

Returns:

#language_descriptionString

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

Returns:

  • (String)

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

#nameString

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

Returns:

  • (String)

    Name of the caption description.