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

Class: Aws::ElasticTranscoder::Types::CaptionFormat

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 CaptionFormat data as a hash:

{
  format: "CaptionFormatFormat",
  pattern: "CaptionFormatPattern",
  encryption: {
    mode: "EncryptionMode",
    key: "Base64EncodedString",
    key_md_5: "Base64EncodedString",
    initialization_vector: "ZeroTo255String",
  },
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#encryptionTypes::Encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

Returns:



516
517
518
519
520
521
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 516

class CaptionFormat < Struct.new(
  :format,
  :pattern,
  :encryption)
  include Aws::Structure
end

#formatString

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

  • Valid Embedded Caption Formats:

    • for FLAC: None

    • For MP3: None

    • For MP4: mov-text

    • For MPEG-TS: None

    • For ogg: None

    • For webm: None

  • Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

    • For FMP4: dfxp

    • Non-FMP4 outputs: All sidecar types

    fmp4 captions have an extension of .ismt

Returns:

  • (String)


516
517
518
519
520
521
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 516

class CaptionFormat < Struct.new(
  :format,
  :pattern,
  :encryption)
  include Aws::Structure
end

#patternString

The prefix for caption filenames, in the form description-\{language\}, where:

  • description is a description of the video.

  • \{language\} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include \{language\} in the file name pattern, Elastic Transcoder automatically appends "\{language\}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language\}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.

Returns:

  • (String)


516
517
518
519
520
521
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 516

class CaptionFormat < Struct.new(
  :format,
  :pattern,
  :encryption)
  include Aws::Structure
end