class Aws::MediaConvert::Types::CaptionDescriptionPreset

Caption Description for preset

@note When making an API call, you may pass CaptionDescriptionPreset

data as a hash:

    {
      custom_language_code: "__stringPatternAZaZ23AZaZ",
      destination_settings: {
        burnin_destination_settings: {
          alignment: "CENTERED", # 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,
          font_resolution: 1,
          font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
          font_size: 1,
          outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
          outline_size: 1,
          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", # 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
          background_color: "NONE", # accepts NONE, BLACK, WHITE
          background_opacity: 1,
          dds_handling: "NONE", # accepts NONE, SPECIFIED, NO_DISPLAY_WINDOW
          dds_x_coordinate: 1,
          dds_y_coordinate: 1,
          font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
          font_opacity: 1,
          font_resolution: 1,
          font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
          font_size: 1,
          height: 1,
          outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
          outline_size: 1,
          shadow_color: "NONE", # accepts NONE, BLACK, WHITE
          shadow_opacity: 1,
          shadow_x_offset: 1,
          shadow_y_offset: 1,
          subtitling_type: "HEARING_IMPAIRED", # accepts HEARING_IMPAIRED, STANDARD
          teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
          width: 1,
          x_position: 1,
          y_position: 1,
        },
        embedded_destination_settings: {
          destination_608_channel_number: 1,
          destination_708_service_number: 1,
        },
        imsc_destination_settings: {
          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: {
          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",
    }

@!attribute [rw] custom_language_code

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.
@return [String]

@!attribute [rw] destination_settings

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.
@return [Types::CaptionDestinationSettings]

@!attribute [rw] language_code

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.
@return [String]

@!attribute [rw] language_description

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/CaptionDescriptionPreset AWS API Documentation

Constants

SENSITIVE