Class: Aws::MediaConvert::Types::CaptionDescription

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

Overview

Note:

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

{
  caption_selector_name: "__stringMin1",
  custom_language_code: "__stringPatternAZaZ23AZaZ",
  destination_settings: {
    burnin_destination_settings: {
      alignment: "CENTERED", # accepts CENTERED, LEFT, AUTO
      apply_font_color: "WHITE_TEXT_ONLY", # accepts WHITE_TEXT_ONLY, ALL_TEXT
      background_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
      background_opacity: 1,
      fallback_font: "BEST_MATCH", # accepts BEST_MATCH, MONOSPACED_SANSSERIF, MONOSPACED_SERIF, PROPORTIONAL_SANSSERIF, PROPORTIONAL_SERIF
      font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE, HEX, AUTO
      font_opacity: 1,
      font_resolution: 1,
      font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
      font_size: 1,
      hex_font_color: "__stringMin6Max8Pattern09aFAF609aFAF2",
      outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE, AUTO
      outline_size: 1,
      shadow_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
      shadow_opacity: 1,
      shadow_x_offset: 1,
      shadow_y_offset: 1,
      style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
      teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL, AUTO
      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, AUTO
      apply_font_color: "WHITE_TEXT_ONLY", # accepts WHITE_TEXT_ONLY, ALL_TEXT
      background_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
      background_opacity: 1,
      dds_handling: "NONE", # accepts NONE, SPECIFIED, NO_DISPLAY_WINDOW
      dds_x_coordinate: 1,
      dds_y_coordinate: 1,
      fallback_font: "BEST_MATCH", # accepts BEST_MATCH, MONOSPACED_SANSSERIF, MONOSPACED_SERIF, PROPORTIONAL_SANSSERIF, PROPORTIONAL_SERIF
      font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE, HEX, AUTO
      font_opacity: 1,
      font_resolution: 1,
      font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
      font_size: 1,
      height: 1,
      hex_font_color: "__stringMin6Max8Pattern09aFAF609aFAF2",
      outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE, AUTO
      outline_size: 1,
      shadow_color: "NONE", # accepts NONE, BLACK, WHITE, AUTO
      shadow_opacity: 1,
      shadow_x_offset: 1,
      shadow_y_offset: 1,
      style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
      subtitling_type: "HEARING_IMPAIRED", # accepts HEARING_IMPAIRED, STANDARD
      teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL, AUTO
      width: 1,
      x_position: 1,
      y_position: 1,
    },
    embedded_destination_settings: {
      destination_608_channel_number: 1,
      destination_708_service_number: 1,
    },
    imsc_destination_settings: {
      accessibility: "DISABLED", # accepts DISABLED, ENABLED
      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
    },
    srt_destination_settings: {
      style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
    },
    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
    },
    webvtt_destination_settings: {
      accessibility: "DISABLED", # accepts DISABLED, ENABLED
      style_passthrough: "ENABLED", # accepts ENABLED, DISABLED, STRICT
    },
  },
  language_code: "ENG", # accepts ENG, SPA, FRA, DEU, GER, ZHO, ARA, HIN, JPN, RUS, POR, ITA, URD, VIE, KOR, PAN, ABK, AAR, AFR, AKA, SQI, AMH, ARG, HYE, ASM, AVA, AVE, AYM, AZE, BAM, BAK, EUS, BEL, BEN, BIH, BIS, BOS, BRE, BUL, MYA, CAT, KHM, CHA, CHE, NYA, CHU, CHV, COR, COS, CRE, HRV, CES, DAN, DIV, NLD, DZO, ENM, EPO, EST, EWE, FAO, FIJ, FIN, FRM, FUL, GLA, GLG, LUG, KAT, ELL, GRN, GUJ, HAT, HAU, HEB, HER, HMO, HUN, ISL, IDO, IBO, IND, INA, ILE, IKU, IPK, GLE, JAV, KAL, KAN, KAU, KAS, KAZ, KIK, KIN, KIR, KOM, KON, KUA, KUR, LAO, LAT, LAV, LIM, LIN, LIT, LUB, LTZ, MKD, MLG, MSA, MAL, MLT, GLV, MRI, MAR, MAH, MON, NAU, NAV, NDE, NBL, NDO, NEP, SME, NOR, NOB, NNO, OCI, OJI, ORI, ORM, OSS, PLI, FAS, POL, PUS, QUE, QAA, RON, ROH, RUN, SMO, SAG, SAN, SRD, SRB, SNA, III, SND, SIN, SLK, SLV, SOM, SOT, SUN, SWA, SSW, SWE, TGL, TAH, TGK, TAM, TAT, TEL, THA, BOD, TIR, TON, TSO, TSN, TUR, TUK, TWI, UIG, UKR, UZB, VEN, VOL, WLN, CYM, FRY, WOL, XHO, YID, YOR, ZHA, ZUL, ORJ, QPC, TNG, SRP
  language_description: "__string",
}

This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#caption_selector_nameString

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

Returns:

  • (String)


2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2242

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  SENSITIVE = []
  include Aws::Structure
end

#custom_language_codeString

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Returns:

  • (String)


2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2242

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  SENSITIVE = []
  include Aws::Structure
end

#destination_settingsTypes::CaptionDestinationSettings

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.



2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2242

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Returns:

  • (String)


2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2242

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  SENSITIVE = []
  include Aws::Structure
end

#language_descriptionString

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Returns:

  • (String)


2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2242

class CaptionDescription < Struct.new(
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  SENSITIVE = []
  include Aws::Structure
end