/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ElasticTranscoder { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class CaptionFormat { public: AWS_ELASTICTRANSCODER_API CaptionFormat(); AWS_ELASTICTRANSCODER_API CaptionFormat(Aws::Utils::Json::JsonView jsonValue); AWS_ELASTICTRANSCODER_API CaptionFormat& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_ELASTICTRANSCODER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

    • *
*/ inline const Aws::String& GetFormat() const{ return m_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

    • *
*/ inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; } /** *

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

    • *
*/ inline void SetFormat(const Aws::String& value) { m_formatHasBeenSet = true; m_format = value; } /** *

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

    • *
*/ inline void SetFormat(Aws::String&& value) { m_formatHasBeenSet = true; m_format = std::move(value); } /** *

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

    • *
*/ inline void SetFormat(const char* value) { m_formatHasBeenSet = true; m_format.assign(value); } /** *

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

    • *
*/ inline CaptionFormat& WithFormat(const Aws::String& value) { SetFormat(value); return *this;} /** *

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

    • *
*/ inline CaptionFormat& WithFormat(Aws::String&& value) { SetFormat(std::move(value)); return *this;} /** *

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

    • *
*/ inline CaptionFormat& WithFormat(const char* value) { SetFormat(value); return *this;} /** *

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.

*/ inline const Aws::String& GetPattern() const{ return m_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.

*/ inline bool PatternHasBeenSet() const { return m_patternHasBeenSet; } /** *

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.

*/ inline void SetPattern(const Aws::String& value) { m_patternHasBeenSet = true; m_pattern = value; } /** *

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.

*/ inline void SetPattern(Aws::String&& value) { m_patternHasBeenSet = true; m_pattern = std::move(value); } /** *

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.

*/ inline void SetPattern(const char* value) { m_patternHasBeenSet = true; m_pattern.assign(value); } /** *

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.

*/ inline CaptionFormat& WithPattern(const Aws::String& value) { SetPattern(value); return *this;} /** *

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.

*/ inline CaptionFormat& WithPattern(Aws::String&& value) { SetPattern(std::move(value)); return *this;} /** *

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.

*/ inline CaptionFormat& WithPattern(const char* value) { SetPattern(value); return *this;} /** *

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

*/ inline const Encryption& GetEncryption() const{ return m_encryption; } /** *

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

*/ inline bool EncryptionHasBeenSet() const { return m_encryptionHasBeenSet; } /** *

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

*/ inline void SetEncryption(const Encryption& value) { m_encryptionHasBeenSet = true; m_encryption = value; } /** *

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

*/ inline void SetEncryption(Encryption&& value) { m_encryptionHasBeenSet = true; m_encryption = std::move(value); } /** *

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

*/ inline CaptionFormat& WithEncryption(const Encryption& value) { SetEncryption(value); return *this;} /** *

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

*/ inline CaptionFormat& WithEncryption(Encryption&& value) { SetEncryption(std::move(value)); return *this;} private: Aws::String m_format; bool m_formatHasBeenSet = false; Aws::String m_pattern; bool m_patternHasBeenSet = false; Encryption m_encryption; bool m_encryptionHasBeenSet = false; }; } // namespace Model } // namespace ElasticTranscoder } // namespace Aws