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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#caption_selector_nameString

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)


1610
1611
1612
1613
1614
1615
1616
1617
1618
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1610

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

#custom_language_codeString

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)


1610
1611
1612
1613
1614
1615
1616
1617
1618
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1610

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

#destination_settingsTypes::CaptionDestinationSettings

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.



1610
1611
1612
1613
1614
1615
1616
1617
1618
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1610

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

#language_codeString

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)


1610
1611
1612
1613
1614
1615
1616
1617
1618
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1610

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

#language_descriptionString

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)


1610
1611
1612
1613
1614
1615
1616
1617
1618
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1610

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