class Aws::MediaLive::Types::CaptionDescription

Caption Description

@note 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
    }

@!attribute [rw] caption_selector_name

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

@!attribute [rw] destination_settings

Additional settings for captions destination that depend on the
destination type.
@return [Types::CaptionDestinationSettings]

@!attribute [rw] language_code

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
@return [String]

@!attribute [rw] language_description

Human readable information to indicate captions available for
players (eg. English, or Spanish).
@return [String]

@!attribute [rw] name

Name of the caption description. Used to associate a caption
description with an output. Names must be unique within an event.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/CaptionDescription AWS API Documentation

Constants

SENSITIVE