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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CaptionSource as input to an Aws::Client method, you can use a vanilla 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:

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

#keyString

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

Returns:

  • (String)

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

#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)

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

#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)

    A string that specifies the language of the caption.

#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)

    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.