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

Class: Aws::MediaConvert::Types::CaptionSelector

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

{
  custom_language_code: "__stringMin3Max3PatternAZaZ3",
  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
  source_settings: { # required
    ancillary_source_settings: {
      source_ancillary_channel_number: 1,
    },
    dvb_sub_source_settings: {
      pid: 1,
    },
    embedded_source_settings: {
      convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
      source_608_channel_number: 1,
      source_608_track_number: 1,
    },
    file_source_settings: {
      convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
      source_file: "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI", # required
      time_delta: 1,
    },
    source_type: "ANCILLARY", # required, accepts ANCILLARY, DVB_SUB, EMBEDDED, SCC, TTML, STL, SRT, TELETEXT, NULL_SOURCE
    teletext_source_settings: {
      page_number: "__stringMin3Max3Pattern1809aFAF09aEAE",
    },
  },
}

Set up captions in your outputs by first selecting them from your input here.

Instance Attribute Summary collapse

Instance Attribute Details

#custom_language_codeString

The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.

Returns:

  • (String)


1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1300

class CaptionSelector < Struct.new(
  :custom_language_code,
  :language_code,
  :source_settings)
  include Aws::Structure
end

#language_codeString

The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.

Returns:

  • (String)


1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1300

class CaptionSelector < Struct.new(
  :custom_language_code,
  :language_code,
  :source_settings)
  include Aws::Structure
end

#source_settingsTypes::CaptionSourceSettings

Source settings (SourceSettings) contains the group of settings for captions in the input.



1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1300

class CaptionSelector < Struct.new(
  :custom_language_code,
  :language_code,
  :source_settings)
  include Aws::Structure
end