Class: Aws::ElasticTranscoder::Types::CaptionSource

Inherits:

Struct

• Object
• Struct
• Aws::ElasticTranscoder::Types::CaptionSource

Includes:

Structure

Defined in:

lib/aws-sdk-elastictranscoder/types.rb

Overview

Note:

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

{
  key: "LongKey",
  language: "Key",
  time_offset: "TimeOffset",
  label: "Name",
  encryption: {
    mode: "EncryptionMode",
    key: "Base64EncodedString",
    key_md_5: "Base64EncodedString",
    initialization_vector: "ZeroTo255String",
  },
}

A source file for the input sidecar captions used during the transcoding process.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #encryption ⇒ Types::Encryption

  The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

• #key ⇒ String

  The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

• #label ⇒ String

  The label of the caption shown in the player when choosing a language.

• #language ⇒ String

  A string that specifies the language of the caption.

• #time_offset ⇒ String

  For clip generation or captions that do not start at the same time as the associated video file, the ‘TimeOffset` tells Elastic Transcoder how much of the video to encode before including captions.

Instance Attribute Details

#encryption ⇒ Types::Encryption

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

Returns:

• (Types::Encryption)

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

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

Returns:

• (String)

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

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  include Aws::Structure
end

#label ⇒ String

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

Returns:

• (String)

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

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  include Aws::Structure
end

#language ⇒ String

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

Returns:

• (String)

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

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  include Aws::Structure
end

#time_offset ⇒ String

For clip generation or captions that do not start at the same time as the associated video file, the ‘TimeOffset` tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

Returns:

• (String)

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

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  include Aws::Structure
end