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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elastictranscoder/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.

Instance Attribute Summary collapse

Instance Attribute Details

#caption_formatsArray<Types::CaptionFormat>

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

Returns:



661
662
663
664
665
666
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 661

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

#caption_sourcesArray<Types::CaptionSource>

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

Returns:



661
662
663
664
665
666
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 661

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

#merge_policyString

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)


661
662
663
664
665
666
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 661

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