Struct WebVttSubtitle

pub struct WebVttSubtitle { /* private fields */ }

WebVTT (.vtt) subtitle data

Implementations

impl WebVttSubtitle

pub fn builder() -> __WebVttSubtitleBuilder<(__Optional<Option<String>>, __Optional<Vec<WebVttCue>>, __Optional<Vec<String>>, __Optional<Vec<String>>)>

Create a new WebVttSubtitle

Arguments

• header: Header (optional)
• cues: List of cues
• styles: List of styles (strings)
• regions: List of regions (strings)

impl WebVttSubtitle

pub fn header(&self) -> Option<&String>

Get header

Examples found in repository

examples/basic.rs (line 8)

fn main() -> Result<(), Error> {
    // We can directly specify the format to open a subtitle file
    let vtt = WebVttSubtitle::from_path("/path/to/some.vtt")?;

    // and then directly work with its data
    println!("{}", vtt.header().cloned().unwrap_or_default());

    // or we could use the more general interface to open (timed) subtitle files
    let sub = TimedSubtitleFile::new("/path/to/file.srt")?;

    // Move the underlying data out in order to access format-specific properties
    // Note that if the format doesn't match, this will perform a conversion instead of just moving the data
    let mut srt = SubRipSubtitle::from(sub);

    // Now we can access format-specific methods like SubRipSubtitle::renumber()
    srt.renumber();

    // Access and modify events
    for event in srt.events_mut() {
        event.shift(600.into());
    }

    // Write the modified subtitle to file
    srt.export("/path/to/output.srt")?;

    Ok(())
}

pub fn set_header(&mut self, header: impl Into<Option<String>>)

Change header to specified option

pub fn styles(&self) -> &[String]

Get list of styles as a slice

pub fn styles_mut(&mut self) -> &mut [String]

Get list of styles as a mutable slice

pub fn style(&self, index: usize) -> Option<&String>

Get style at index

pub fn style_mut(&mut self, index: usize) -> Option<&mut String>

Get mutable style at index

pub fn regions(&self) -> &[String]

Get list of regions as a slice

pub fn regions_mut(&mut self) -> &mut [String]

Get list of regions as a mutable slice

pub fn region(&self, index: usize) -> Option<&String>

Get region at index

pub fn region_mut(&mut self, index: usize) -> Option<&mut String>

Get mutable region at index

Trait Implementations

impl Clone for WebVttSubtitle

fn clone(&self) -> WebVttSubtitle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebVttSubtitle

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

Formats the value using the given formatter.

impl Default for WebVttSubtitle

fn default() -> Self

Returns the “default value” for a type.

impl Display for WebVttSubtitle

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

Formats the value using the given formatter.

impl From<&AssSubtitle> for WebVttSubtitle

fn from(value: &AssSubtitle) -> Self

Converts to this type from the input type.

impl From<&SsaSubtitle> for WebVttSubtitle

fn from(value: &SsaSubtitle) -> Self

Converts to this type from the input type.

impl From<&SubRipSubtitle> for WebVttSubtitle

fn from(value: &SubRipSubtitle) -> Self

Convert a SubRip (.srt) subtitle to WebVTT format.

This sets the line number as the cue identifier.

The supported tags are <b>, <i>, and <u>. Any other tags will be stripped from the text.

Bracket tags (of the form {b}) will be converted to HTML tags (<b>).

impl From<&TimedMicroDvdSubtitle> for WebVttSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<&WebVttSubtitle> for AssSubtitle

fn from(value: &WebVttSubtitle) -> Self

Convert WebVTT (.vtt) format subtitle to .ass format.

For each line, this will convert newlines into the appropriate representation, and it will also convert the basic HTML formatting tags (<b>, <i>, and <u>).

All other tags and styles are discarded.

impl From<&WebVttSubtitle> for SsaSubtitle

fn from(value: &WebVttSubtitle) -> Self

Convert WebVTT (.vtt) format subtitle to .ssa format.

For each line, this will convert newlines into the appropriate representation, and it will also convert the basic HTML formatting tags (<b>, <i>, and <u>).

All other tags and styles are discarded.

impl From<&WebVttSubtitle> for SubRipSubtitle

fn from(value: &WebVttSubtitle) -> Self

Convert WebVTT (.vtt) subtitle to .srt format

Cue identifiers that are numbers will be treated as line numbers for the corresponding event in the .srt output.

impl From<&WebVttSubtitle> for TimedMicroDvdSubtitle

fn from(value: &WebVttSubtitle) -> Self

Converts to this type from the input type.

impl From<AssSubtitle> for WebVttSubtitle

fn from(value: AssSubtitle) -> Self

Converts to this type from the input type.

impl From<PlainSubtitle> for WebVttSubtitle

fn from(value: PlainSubtitle) -> Self

Converts to this type from the input type.

impl From<SsaSubtitle> for WebVttSubtitle

fn from(value: SsaSubtitle) -> Self

Converts to this type from the input type.

impl From<SubRipSubtitle> for WebVttSubtitle

fn from(value: SubRipSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedMicroDvdSubtitle> for WebVttSubtitle

fn from(value: TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedSubtitleFile> for WebVttSubtitle

fn from(value: TimedSubtitleFile) -> Self

Converts to this type from the input type.

impl From<WebVttSubtitle> for AssSubtitle

fn from(value: WebVttSubtitle) -> Self

Converts to this type from the input type.

impl From<WebVttSubtitle> for SsaSubtitle

fn from(value: WebVttSubtitle) -> Self

Converts to this type from the input type.

impl From<WebVttSubtitle> for SubRipSubtitle

fn from(value: WebVttSubtitle) -> Self

Converts to this type from the input type.

impl FromStr for WebVttSubtitle

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Subtitle for WebVttSubtitle

type Event = WebVttCue

Event type for the given subtitle format

fn from_path_with_encoding( path: impl AsRef<Path>, encoding: Option<&'static Encoding>, ) -> Result<Self, Error>

Load subtitle format from path using the given encoding

fn events(&self) -> &[WebVttCue]

Get list of events as a slice

fn events_mut(&mut self) -> &mut [WebVttCue]

Get list of events as a mutable slice

fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

Load subtitle from given path. Automatically attempts to detect the encoding to use from the file contents.

fn event(&self, index: usize) -> Option<&Self::Event>

Try to get event at given index

fn event_mut(&mut self, index: usize) -> Option<&mut Self::Event>

Try to get mutable event at given index

fn export(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write subtitles to file at the given path

impl TextSubtitle for WebVttSubtitle

fn strip_formatting(&mut self)

Remove all styling/formatting information from the text and subtitle metadata

impl TimedSubtitle for WebVttSubtitle

fn shift(&mut self, delta: TimeDelta)

where <Self as Subtitle>::Event: TimedEvent,

Shift all events in subtitle by given amount of time, in milliseconds.