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

Class: Aws::MediaConvert::Types::CaptionDescriptionPreset

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 CaptionDescriptionPreset data as a hash:

{
  custom_language_code: "__stringMin3Max3PatternAZaZ3",
  destination_settings: { # required
    burnin_destination_settings: {
      alignment: "CENTERED", # required, accepts CENTERED, LEFT
      background_color: "NONE", # accepts NONE, BLACK, WHITE
      background_opacity: 1,
      font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
      font_opacity: 1, # required
      font_resolution: 1,
      font_size: 1,
      outline_color: "BLACK", # required, accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
      outline_size: 1, # required
      shadow_color: "NONE", # accepts NONE, BLACK, WHITE
      shadow_opacity: 1,
      shadow_x_offset: 1,
      shadow_y_offset: 1,
      teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
      x_position: 1,
      y_position: 1,
    },
    destination_type: "BURN_IN", # required, accepts BURN_IN, DVB_SUB, EMBEDDED, SCC, SRT, TELETEXT, TTML, WEBVTT
    dvb_sub_destination_settings: {
      alignment: "CENTERED", # required, accepts CENTERED, LEFT
      background_color: "NONE", # accepts NONE, BLACK, WHITE
      background_opacity: 1,
      font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
      font_opacity: 1, # required
      font_resolution: 1,
      font_size: 1,
      outline_color: "BLACK", # required, accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
      outline_size: 1, # required
      shadow_color: "NONE", # accepts NONE, BLACK, WHITE
      shadow_opacity: 1,
      shadow_x_offset: 1,
      shadow_y_offset: 1,
      teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
      x_position: 1,
      y_position: 1,
    },
    scc_destination_settings: {
      framerate: "FRAMERATE_23_97", # accepts FRAMERATE_23_97, FRAMERATE_24, FRAMERATE_29_97_DROPFRAME, FRAMERATE_29_97_NON_DROPFRAME
    },
    teletext_destination_settings: {
      page_number: "__stringMin3Max3Pattern1809aFAF09aEAE",
    },
    ttml_destination_settings: {
      style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  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
  language_description: "__string",
}

Caption Description for preset

Instance Attribute Summary collapse

Instance Attribute Details

#custom_language_codeString

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code

Returns:

  • (String)


1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1137

class CaptionDescriptionPreset < Struct.new(
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  include Aws::Structure
end

#destination_settingsTypes::CaptionDestinationSettings

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.



1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1137

class CaptionDescriptionPreset < Struct.new(
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  include Aws::Structure
end

#language_codeString

Indicates the language of the caption output track.

Returns:

  • (String)


1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1137

class CaptionDescriptionPreset < Struct.new(
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  include Aws::Structure
end

#language_descriptionString

Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal.

Returns:

  • (String)


1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1137

class CaptionDescriptionPreset < Struct.new(
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description)
  include Aws::Structure
end