Struct CaptionFormat

#[non_exhaustive]
pub struct CaptionFormat {
    pub format: Option<String>,
    pub pattern: Option<String>,
    pub encryption: Option<Encryption>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: Option<String>

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

pattern: Option<String>

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.

encryption: Option<Encryption>

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

Implementations

impl CaptionFormat

pub fn format(&self) -> Option<&str>

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

pub fn pattern(&self) -> Option<&str>

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.

pub fn encryption(&self) -> Option<&Encryption>

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

impl CaptionFormat

pub fn builder() -> CaptionFormatBuilder

Creates a new builder-style object to manufacture CaptionFormat.

Trait Implementations

impl Clone for CaptionFormat

fn clone(&self) -> CaptionFormat

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CaptionFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CaptionFormat

fn eq(&self, other: &CaptionFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CaptionFormat