Struct aws_sdk_mediaconvert::types::CaptionDescription

#[non_exhaustive]
pub struct CaptionDescription {
    pub caption_selector_name: Option<String>,
    pub custom_language_code: Option<String>,
    pub destination_settings: Option<CaptionDestinationSettings>,
    pub language_code: Option<LanguageCode>,
    pub language_description: Option<String>,
}

This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.

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.

caption_selector_name: Option<String>

Specifies which “Caption Selector”:#inputs-caption_selector to use from each input when generating captions. The name should be of the format “Caption Selector “, which denotes that the Nth Caption Selector will be used from each input.

custom_language_code: Option<String>

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

destination_settings: Option<CaptionDestinationSettings>

Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

language_code: Option<LanguageCode>

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

language_description: Option<String>

Specify a label for this set of output captions. For example, “English”, “Director commentary”, or “track_2”. For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer’s player device. For outputs in other output groups, the service ignores this setting.

Implementations

impl CaptionDescription

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

Specifies which “Caption Selector”:#inputs-caption_selector to use from each input when generating captions. The name should be of the format “Caption Selector “, which denotes that the Nth Caption Selector will be used from each input.

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

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

pub fn destination_settings(&self) -> Option<&CaptionDestinationSettings>

Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

pub fn language_code(&self) -> Option<&LanguageCode>

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

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

Specify a label for this set of output captions. For example, “English”, “Director commentary”, or “track_2”. For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer’s player device. For outputs in other output groups, the service ignores this setting.

impl CaptionDescription

pub fn builder() -> CaptionDescriptionBuilder

Creates a new builder-style object to manufacture CaptionDescription.

Trait Implementations

impl Clone for CaptionDescription

fn clone(&self) -> CaptionDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CaptionDescription

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

Formats the value using the given formatter.

impl PartialEq for CaptionDescription

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CaptionDescription