Struct CaptionSource

#[non_exhaustive]
pub struct CaptionSource {
    pub key: Option<String>,
    pub language: Option<String>,
    pub time_offset: Option<String>,
    pub label: Option<String>,
    pub encryption: Option<Encryption>,
}

A source file for the input sidecar captions used during the transcoding process.

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.

key: Option<String>

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

language: Option<String>

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

time_offset: Option<String>

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form \[+-\]SS.sss or \[+-\]HH:mm:SS.ss.

label: Option<String>

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

encryption: Option<Encryption>

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

Implementations

impl CaptionSource

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

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

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

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

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

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form \[+-\]SS.sss or \[+-\]HH:mm:SS.ss.

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

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

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

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

impl CaptionSource

pub fn builder() -> CaptionSourceBuilder

Creates a new builder-style object to manufacture CaptionSource.

Trait Implementations

impl Clone for CaptionSource

fn clone(&self) -> CaptionSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CaptionSource

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

Formats the value using the given formatter.

impl PartialEq for CaptionSource

fn eq(&self, other: &CaptionSource) -> 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 CaptionSource