AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.ElasticTranscoder.Model.CaptionFormat

Namespace: Amazon.ElasticTranscoder.Model
Assembly: AWSSDK.ElasticTranscoder.dll
Version: 3.x.y.z

Syntax

C#
public class CaptionFormat

The CaptionFormat type exposes the following members

Constructors

NameDescription
Public Method CaptionFormat()

Properties

NameTypeDescription
Public Property Encryption Amazon.ElasticTranscoder.Model.Encryption

Gets and sets the property Encryption.

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

Public Property Format System.String

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

Public Property Pattern System.String

Gets and sets the property Pattern.

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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms