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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

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:



511
512
513
514
515
516
517
518
519
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 511

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  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)


511
512
513
514
515
516
517
518
519
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 511

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  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)


511
512
513
514
515
516
517
518
519
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 511

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  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)


511
512
513
514
515
516
517
518
519
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 511

class CaptionSource < Struct.new(
  :key,
  :language,
  :time_offset,
  :label,
  :encryption)
  SENSITIVE = []
  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)


511
512
513
514
515
516
517
518
519
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 511

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