AWS SDK for .NET Documentation
CaptionFormat Class
Amazon ► Amazon.ElasticTranscoder.Model ► CaptionFormat Did this page help you?   Yes   No    Tell us about it...
The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
Declaration Syntax
C#
public class CaptionFormat
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CaptionFormat()()()()
Initializes a new instance of the CaptionFormat class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Format
Gets and sets the property Format.

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

  • Valid Embedded Caption Formats:

    • 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. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.


GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Pattern
Gets and sets the property Pattern.

The prefix for caption filenames, in the form description-

CopyC#
{language}
, where:

  • description is a description of the video.
  • CopyC#
    {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

CopyC#
{language}
in the file name pattern, Elastic Transcoder automatically appends "
CopyC#
{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 will be Sydney-en-sunrise00000.srt.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithFormat(String) Obsolete.
Sets the Format property

WithPattern(String) Obsolete.
Sets the Pattern property

Inheritance Hierarchy
Object
CaptionFormat

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)