AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticTranscoder::Model::CaptionFormat Class Reference

#include <CaptionFormat.h>

Public Member Functions

 CaptionFormat ()
 
 CaptionFormat (Aws::Utils::Json::JsonView jsonValue)
 
CaptionFormatoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetFormat () const
 
bool FormatHasBeenSet () const
 
void SetFormat (const Aws::String &value)
 
void SetFormat (Aws::String &&value)
 
void SetFormat (const char *value)
 
CaptionFormatWithFormat (const Aws::String &value)
 
CaptionFormatWithFormat (Aws::String &&value)
 
CaptionFormatWithFormat (const char *value)
 
const Aws::StringGetPattern () const
 
bool PatternHasBeenSet () const
 
void SetPattern (const Aws::String &value)
 
void SetPattern (Aws::String &&value)
 
void SetPattern (const char *value)
 
CaptionFormatWithPattern (const Aws::String &value)
 
CaptionFormatWithPattern (Aws::String &&value)
 
CaptionFormatWithPattern (const char *value)
 
const EncryptionGetEncryption () const
 
bool EncryptionHasBeenSet () const
 
void SetEncryption (const Encryption &value)
 
void SetEncryption (Encryption &&value)
 
CaptionFormatWithEncryption (const Encryption &value)
 
CaptionFormatWithEncryption (Encryption &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 33 of file CaptionFormat.h.

Constructor & Destructor Documentation

◆ CaptionFormat() [1/2]

Aws::ElasticTranscoder::Model::CaptionFormat::CaptionFormat ( )

◆ CaptionFormat() [2/2]

Aws::ElasticTranscoder::Model::CaptionFormat::CaptionFormat ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EncryptionHasBeenSet()

bool Aws::ElasticTranscoder::Model::CaptionFormat::EncryptionHasBeenSet ( ) const
inline

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

Definition at line 318 of file CaptionFormat.h.

◆ FormatHasBeenSet()

bool Aws::ElasticTranscoder::Model::CaptionFormat::FormatHasBeenSet ( ) const
inline

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

Definition at line 72 of file CaptionFormat.h.

◆ GetEncryption()

const Encryption& Aws::ElasticTranscoder::Model::CaptionFormat::GetEncryption ( ) const
inline

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

Definition at line 312 of file CaptionFormat.h.

◆ GetFormat()

const Aws::String& Aws::ElasticTranscoder::Model::CaptionFormat::GetFormat ( ) const
inline

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

Definition at line 56 of file CaptionFormat.h.

◆ GetPattern()

const Aws::String& Aws::ElasticTranscoder::Model::CaptionFormat::GetPattern ( ) const
inline

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 "<code>{language}</code>" 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.

Definition at line 186 of file CaptionFormat.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ElasticTranscoder::Model::CaptionFormat::Jsonize ( ) const

◆ operator=()

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PatternHasBeenSet()

bool Aws::ElasticTranscoder::Model::CaptionFormat::PatternHasBeenSet ( ) const
inline

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 "<code>{language}</code>" 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.

Definition at line 203 of file CaptionFormat.h.

◆ SetEncryption() [1/2]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetEncryption ( const Encryption value)
inline

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

Definition at line 324 of file CaptionFormat.h.

◆ SetEncryption() [2/2]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetEncryption ( Encryption &&  value)
inline

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

Definition at line 330 of file CaptionFormat.h.

◆ SetFormat() [1/3]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetFormat ( Aws::String &&  value)
inline

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

Definition at line 104 of file CaptionFormat.h.

◆ SetFormat() [2/3]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetFormat ( const Aws::String value)
inline

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

Definition at line 88 of file CaptionFormat.h.

◆ SetFormat() [3/3]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetFormat ( const char *  value)
inline

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

Definition at line 120 of file CaptionFormat.h.

◆ SetPattern() [1/3]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetPattern ( Aws::String &&  value)
inline

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 "<code>{language}</code>" 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.

Definition at line 237 of file CaptionFormat.h.

◆ SetPattern() [2/3]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetPattern ( const Aws::String value)
inline

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 "<code>{language}</code>" 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.

Definition at line 220 of file CaptionFormat.h.

◆ SetPattern() [3/3]

void Aws::ElasticTranscoder::Model::CaptionFormat::SetPattern ( const char *  value)
inline

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 "<code>{language}</code>" 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.

Definition at line 254 of file CaptionFormat.h.

◆ WithEncryption() [1/2]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithEncryption ( const Encryption value)
inline

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

Definition at line 336 of file CaptionFormat.h.

◆ WithEncryption() [2/2]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithEncryption ( Encryption &&  value)
inline

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

Definition at line 342 of file CaptionFormat.h.

◆ WithFormat() [1/3]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithFormat ( Aws::String &&  value)
inline

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

Definition at line 152 of file CaptionFormat.h.

◆ WithFormat() [2/3]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithFormat ( const Aws::String value)
inline

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

Definition at line 136 of file CaptionFormat.h.

◆ WithFormat() [3/3]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithFormat ( const char *  value)
inline

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

Definition at line 168 of file CaptionFormat.h.

◆ WithPattern() [1/3]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithPattern ( Aws::String &&  value)
inline

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 "<code>{language}</code>" 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.

Definition at line 288 of file CaptionFormat.h.

◆ WithPattern() [2/3]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithPattern ( const Aws::String value)
inline

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 "<code>{language}</code>" 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.

Definition at line 271 of file CaptionFormat.h.

◆ WithPattern() [3/3]

CaptionFormat& Aws::ElasticTranscoder::Model::CaptionFormat::WithPattern ( const char *  value)
inline

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 "<code>{language}</code>" 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.

Definition at line 305 of file CaptionFormat.h.


The documentation for this class was generated from the following file: