Class: Aws::ElasticTranscoder::Types::Captions

Inherits:

Struct

• Object
• Struct
• Aws::ElasticTranscoder::Types::Captions

Includes:

Structure

Defined in:

lib/aws-sdk-elastictranscoder/types.rb

Overview

Note:

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

{
  merge_policy: "CaptionMergePolicy",
  caption_sources: [
    {
      key: "LongKey",
      language: "Key",
      time_offset: "TimeOffset",
      label: "Name",
      encryption: {
        mode: "EncryptionMode",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
      },
    },
  ],
  caption_formats: [
    {
      format: "CaptionFormatFormat",
      pattern: "CaptionFormatPattern",
      encryption: {
        mode: "EncryptionMode",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
      },
    },
  ],
}

The captions to be created, if any.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #caption_formats ⇒ Array<Types::CaptionFormat>

  The array of file formats for the output captions.

• #caption_sources ⇒ Array<Types::CaptionSource>

  Source files for the input sidecar captions used during the transcoding process.

• #merge_policy ⇒ String

  A policy that determines how Elastic Transcoder handles the existence of multiple captions.

Instance Attribute Details

#caption_formats ⇒ Array<Types::CaptionFormat>

The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

Returns:

• (Array<Types::CaptionFormat>)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 673

class Captions < Struct.new(
  :merge_policy,
  :caption_sources,
  :caption_formats)
  SENSITIVE = []
  include Aws::Structure
end

#caption_sources ⇒ Array<Types::CaptionSource>

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave ‘CaptionSources` blank.

Returns:

• (Array<Types::CaptionSource>)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 673

class Captions < Struct.new(
  :merge_policy,
  :caption_sources,
  :caption_formats)
  SENSITIVE = []
  include Aws::Structure
end

#merge_policy ⇒ String

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

• MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

• MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If ‘CaptionSources` is empty, Elastic Transcoder omits all sidecar captions from the output files.

• Override: Elastic Transcoder transcodes only the sidecar captions that you specify in ‘CaptionSources`.

‘MergePolicy` cannot be null.

Returns:

• (String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 673

class Captions < Struct.new(
  :merge_policy,
  :caption_sources,
  :caption_formats)
  SENSITIVE = []
  include Aws::Structure
end