Skip to main content

CaptionTrack

Struct CaptionTrack 

Source
pub struct CaptionTrack {
    pub cues: Vec<Cue>,
    pub language: String,
    pub label: String,
}
Expand description

An ordered list of Cues plus the metadata a subtitle track carries.

use threers_captions::CaptionTrack;
let track = CaptionTrack::new()
    .language("en")
    .label("English")
    .cue(0.0, 2.0, "First line")
    .cue(2.0, 4.0, "Second line");
assert_eq!(track.duration(), 4.0);
assert!(track.to_vtt().starts_with("WEBVTT"));

Fields§

§cues: Vec<Cue>

Cues, kept sorted by start time by push / cue.

§language: String

BCP-47 language tag ("en", "pt-BR", …). Empty means undetermined.

§label: String

Human-readable track name shown in player menus.

Implementations§

Source§

impl CaptionTrack

Source

pub fn new() -> CaptionTrack

An empty track.

Source

pub fn language(self, language: impl Into<String>) -> CaptionTrack

Set the BCP-47 language tag.

Source

pub fn label(self, label: impl Into<String>) -> CaptionTrack

Set the human-readable track label.

Source

pub fn cue(self, start: f64, end: f64, text: impl Into<String>) -> CaptionTrack

Append a cue (builder form). Keeps cues sorted by start time.

Source

pub fn push(&mut self, cue: Cue)

Append a cue, keeping cues sorted by start time.

Source

pub fn sort(&mut self)

Re-sort cues by start time (then end time). Only needed if cues was mutated directly.

Source

pub fn len(&self) -> usize

Number of cues.

Source

pub fn is_empty(&self) -> bool

Whether the track has no cues.

Source

pub fn duration(&self) -> f64

End time of the last cue, in seconds (0.0 when empty).

Source

pub fn active_at(&self, time: f64) -> Vec<&Cue>

Every cue showing at time seconds, in track order.

Source

pub fn cue_at(&self, time: f64) -> Option<&Cue>

The first cue showing at time seconds — the common case, since most tracks show one cue at a time.

Source

pub fn text_at(&self, time: f64) -> String

Concatenated plain_text of every cue active at time, joined with newlines. Empty when nothing is showing.

Source

pub fn shift(&mut self, seconds: f64)

Shift every cue by seconds (negative moves earlier). Cues never move before zero.

Source

pub fn scale(&mut self, factor: f64)

Scale every cue time by factor — e.g. 24.0 / 25.0 to retime a 25 fps track for 24 fps playback.

Source

pub fn parse_srt(text: &str) -> Result<CaptionTrack, CaptionError>

Parse SubRip (.srt).

Source

pub fn parse_vtt(text: &str) -> Result<CaptionTrack, CaptionError>

Parse WebVTT (.vtt).

Source

pub fn parse(text: &str) -> Result<CaptionTrack, CaptionError>

Parse either format, sniffing the WEBVTT magic.

Source

pub fn to_srt(&self) -> String

Serialize to SubRip.

Source

pub fn to_vtt(&self) -> String

Serialize to WebVTT.

Source

pub fn to_format(&self, format: CaptionFormat) -> String

Serialize to format.

Trait Implementations§

Source§

impl Clone for CaptionTrack

Source§

fn clone(&self) -> CaptionTrack

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CaptionTrack

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CaptionTrack

Source§

fn default() -> CaptionTrack

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CaptionTrack

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CaptionTrack

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.