Class: Aws::MediaConvert::Types::CaptionDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audio_source_names ⇒ Array<String>

Specifies the audio selector or audio selector group that MediaConvert uses to generate Smart subtitles. The audio selector you choose must exist in all inputs for the job. If MediaConvert can't detect speech in the audio, it can't generate subtitles. Required when source is SMART_SUBTITLE; not allowed otherwise.

Returns:

  • (Array<String>) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#caption_selector_name ⇒ String

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#custom_language_code ⇒ String

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.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#destination_settings ⇒ Types::CaptionDestinationSettings

Settings related to one captions tab on the MediaConvert 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.

Returns:



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

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.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#language_description ⇒ String

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.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

Specify the source of the captions for this caption description. Choose Captions input source (INPUT_CAPTION_SELECTOR) to use a caption selector from your input. Choose Smart subtitling (SMART_SUBTITLE) to have MediaConvert and Elemental Inference generate subtitles automatically from an audio source that you specify.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2195

class CaptionDescription < Struct.new(
  :audio_source_names,
  :caption_selector_name,
  :custom_language_code,
  :destination_settings,
  :language_code,
  :language_description,
  :source)
  SENSITIVE = []
  include Aws::Structure
end