Struct SubtitleRenditionDecl 

#[non_exhaustive]
pub struct SubtitleRenditionDecl {
    pub name: String,
    pub language: String,
    pub uri: String,
    pub default: bool,
    pub autoselect: bool,
    pub forced: bool,
    pub hearing_impaired: bool,
}

Available on crate feature std only.

A typed declaration of one WebVTT subtitle rendition for a multivariant playlist (RFC 8216 §4.3.4.1, Apple HLS Authoring Spec items 4.5-4.7, 5.11). Consumed by HlsOriginBuilder::subtitle_renditions. All renditions share the group SUBTITLES_GROUP_ID.

hearing_impaired emits the item 4.5 CHARACTERISTICS and forces AUTOSELECT=YES (item 4.6); forced emits FORCED=YES and forces AUTOSELECT=YES (item 5.11).

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.

name: String

NAME of the rendition.

language: String

LANGUAGE (BCP 47); required (Apple HLS Authoring Spec item 4.7).

uri: String

URI of the subtitle media playlist.

default: bool

DEFAULT attribute.

autoselect: bool

AUTOSELECT attribute.

forced: bool

FORCED attribute.

hearing_impaired: bool

Subtitles for deaf or hard-of-hearing viewers.

Implementations

impl SubtitleRenditionDecl

pub fn new( name: impl Into<String>, language: impl Into<String>, uri: impl Into<String>, ) -> Self

A plain subtitle rendition: DEFAULT=NO, AUTOSELECT=YES, not forced, not for the hard of hearing.

Trait Implementations

impl Clone for SubtitleRenditionDecl

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubtitleRenditionDecl

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

Formats the value using the given formatter.

impl Eq for SubtitleRenditionDecl

impl PartialEq for SubtitleRenditionDecl

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubtitleRenditionDecl