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

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

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 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.

Instance Attribute Summary collapse

Instance Attribute Details

#encryptionTypes::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:



582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 582

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

#keyString

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

Returns:

  • (String)


582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 582

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

#labelString

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)


582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 582

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

#languageString

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)


582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 582

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

#time_offsetString

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)


582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 582

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