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

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

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::CaptionSourceSettings

Defined in:

gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

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

{
  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",
  },
}

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #ancillary_source_settings ⇒ Types::AncillarySourceSettings

  Settings for ancillary captions source.

• #dvb_sub_source_settings ⇒ Types::DvbSubSourceSettings

  DVB Sub Source Settings.

• #embedded_source_settings ⇒ Types::EmbeddedSourceSettings

  Settings for embedded captions Source.

• #file_source_settings ⇒ Types::FileSourceSettings

  Settings for File-based Captions in Source.

• #source_type ⇒ 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.

Instance Attribute Details

#ancillary_source_settings ⇒ Types::AncillarySourceSettings

Settings for ancillary captions source.

Returns:

• (Types::AncillarySourceSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1364

class CaptionSourceSettings < Struct.new(
  :ancillary_source_settings,
  :dvb_sub_source_settings,
  :embedded_source_settings,
  :file_source_settings,
  :source_type,
  :teletext_source_settings)
  include Aws::Structure
end

#dvb_sub_source_settings ⇒ Types::DvbSubSourceSettings

DVB Sub Source Settings

Returns:

• (Types::DvbSubSourceSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1364

class CaptionSourceSettings < Struct.new(
  :ancillary_source_settings,
  :dvb_sub_source_settings,
  :embedded_source_settings,
  :file_source_settings,
  :source_type,
  :teletext_source_settings)
  include Aws::Structure
end

#embedded_source_settings ⇒ Types::EmbeddedSourceSettings

Settings for embedded captions Source

Returns:

• (Types::EmbeddedSourceSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1364

class CaptionSourceSettings < Struct.new(
  :ancillary_source_settings,
  :dvb_sub_source_settings,
  :embedded_source_settings,
  :file_source_settings,
  :source_type,
  :teletext_source_settings)
  include Aws::Structure
end

#file_source_settings ⇒ Types::FileSourceSettings

Settings for File-based Captions in Source

Returns:

• (Types::FileSourceSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1364

class CaptionSourceSettings < Struct.new(
  :ancillary_source_settings,
  :dvb_sub_source_settings,
  :embedded_source_settings,
  :file_source_settings,
  :source_type,
  :teletext_source_settings)
  include Aws::Structure
end

#source_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1364

class CaptionSourceSettings < Struct.new(
  :ancillary_source_settings,
  :dvb_sub_source_settings,
  :embedded_source_settings,
  :file_source_settings,
  :source_type,
  :teletext_source_settings)
  include Aws::Structure
end

#teletext_source_settings ⇒ Types::TeletextSourceSettings

Settings specific to Teletext caption sources, including Page number.

Returns:

• (Types::TeletextSourceSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1364

class CaptionSourceSettings < Struct.new(
  :ancillary_source_settings,
  :dvb_sub_source_settings,
  :embedded_source_settings,
  :file_source_settings,
  :source_type,
  :teletext_source_settings)
  include Aws::Structure
end