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

Class: Aws::MediaConvert::Types::CaptionSourceSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CaptionSourceSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  ancillary_source_settings: {
    convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
    source_ancillary_channel_number: 1,
    terminate_captions: "END_OF_INPUT", # accepts END_OF_INPUT, DISABLED
  },
  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,
    terminate_captions: "END_OF_INPUT", # accepts END_OF_INPUT, DISABLED
  },
  file_source_settings: {
    convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
    framerate: {
      framerate_denominator: 1,
      framerate_numerator: 1,
    },
    source_file: "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI",
    time_delta: 1,
  },
  source_type: "ANCILLARY", # accepts ANCILLARY, DVB_SUB, EMBEDDED, SCTE20, SCC, TTML, STL, SRT, SMI, TELETEXT, NULL_SOURCE, IMSC
  teletext_source_settings: {
    page_number: "__stringMin3Max3Pattern1809aFAF09aEAE",
  },
  track_source_settings: {
    track_number: 1,
  },
}

If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#ancillary_source_settings ⇒ Types::AncillarySourceSettings

Settings for ancillary captions source.

Returns:

#dvb_sub_source_settings ⇒ Types::DvbSubSourceSettings

DVB Sub Source Settings

Returns:

#embedded_source_settings ⇒ Types::EmbeddedSourceSettings

Settings for embedded captions Source

Returns:

#file_source_settings ⇒ Types::FileSourceSettings

If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Returns:

  • (Types::FileSourceSettings) —

    If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file.

#source_type ⇒ String

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Possible values:

  • ANCILLARY
  • DVB_SUB
  • EMBEDDED
  • SCTE20
  • SCC
  • TTML
  • STL
  • SRT
  • SMI
  • TELETEXT
  • NULL_SOURCE
  • IMSC

Returns:

  • (String) —

    Use Source (SourceType) to identify the format of your input captions.

#teletext_source_settings ⇒ Types::TeletextSourceSettings

Settings specific to Teletext caption sources, including Page number.

Returns:

#track_source_settings ⇒ Types::TrackSourceSettings

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Returns: