Struct aspasia::TimedMicroDvdSubtitle

pub struct TimedMicroDvdSubtitle { /* private fields */ }

Timed version of MicroDVD (.sub) subtitle, using user-supplied framerate to calculate timings

When initialised without framerate, the default framerate is 24.

Implementations

impl TimedMicroDvdSubtitle

pub fn from_raw(raw: &MicroDvdSubtitle, framerate: Option<f32>) -> Self

Convert raw MicroDVD subtitle data to timed MicroDVD data, given the framerate the subtitles were created for. If no framerate is given, the default of 24 is used.

pub fn with_framerate( path: impl AsRef<Path>, framerate: f32 ) -> Result<Self, Error>

Create MicroDVD from path given and calculate its timings using the given framerate.

Errors

Returns Error::FileIoError if an error occurs while opening the file

pub fn framerate(&self) -> f32

Get framerate used to create timings

pub fn set_framerate(&mut self, framerate: f32)

Modify framerate associated with subtitle. Does not modify event timings at all.

pub fn update_framerate(&mut self, framerate: f32)

Modify framerate associated with subtitle

This will also recalculate and update all event timings to match the new framerate.

Trait Implementations

impl Debug for TimedMicroDvdSubtitle

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

Formats the value using the given formatter.

impl Display for TimedMicroDvdSubtitle

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

Formats the value using the given formatter.

impl From<&AssSubtitle> for TimedMicroDvdSubtitle

fn from(value: &AssSubtitle) -> Self

Converts to this type from the input type.

impl From<&SsaSubtitle> for TimedMicroDvdSubtitle

fn from(value: &SsaSubtitle) -> Self

Converts to this type from the input type.

impl From<&SubRipSubtitle> for TimedMicroDvdSubtitle

fn from(value: &SubRipSubtitle) -> Self

Converts to this type from the input type.

impl From<&TimedMicroDvdSubtitle> for AssSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<&TimedMicroDvdSubtitle> for MicroDvdSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<&TimedMicroDvdSubtitle> for SsaSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<&TimedMicroDvdSubtitle> for SubRipSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> 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<&WebVttSubtitle> for TimedMicroDvdSubtitle

fn from(value: &WebVttSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedMicroDvdSubtitle> for AssSubtitle

fn from(value: TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedMicroDvdSubtitle> for SsaSubtitle

fn from(value: TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedMicroDvdSubtitle> for SubRipSubtitle

fn from(value: TimedMicroDvdSubtitle) -> 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 FromStr for TimedMicroDvdSubtitle

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 TimedMicroDvdSubtitle

type Event = TimedMicroDvdEvent

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) -> &[Self::Event]

Get list of events as a slice

fn events_mut(&mut self) -> &mut [Self::Event]

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 TimedMicroDvdSubtitle

fn strip_formatting(&mut self)

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

impl TimedSubtitle for TimedMicroDvdSubtitle

fn shift(&mut self, delta: TimeDelta)

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

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