Struct aspasia::SsaSubtitle

pub struct SsaSubtitle { /* private fields */ }

SubStation Alpha v4 (.ssa) subtitle

Implementations

impl SsaSubtitle

pub fn builder( ) -> __SsaSubtitleBuilder<(__Required<SsaScriptInfo>, __Optional<Vec<SsaEvent>>, __Optional<Vec<SsaEvent>>, __Optional<Vec<SsaEvent>>, __Optional<Vec<SsaEvent>>, __Optional<Vec<SsaEvent>>, __Optional<Vec<SsaStyle>>, __Optional<Vec<SubStationFont>>, __Optional<Vec<SubStationGraphic>>)>

Create a new SsaSubtitle

Arguments

• script_info: Script info
• dialogue: Dialogue events
• pictures: Picture events
• sounds: Sound events
• movies: Movie events
• commands: Command events
• styles: Styles
• fonts: Embedded font data
• graphics: Embedded graphics data

impl SsaSubtitle

pub fn pictures(&self) -> &[SsaEvent]

Get list of picture events as a slice

pub fn pictures_mut(&mut self) -> &mut [SsaEvent]

Get list of picture events as a mutable slice

pub fn picture(&self, index: usize) -> Option<&SsaEvent>

Get picture event at given index

pub fn picture_mut(&mut self, index: usize) -> Option<&mut SsaEvent>

Get mutable picture event at given index

pub fn sounds(&self) -> &[SsaEvent]

Get list of sound events as a slice

pub fn sounds_mut(&mut self) -> &mut [SsaEvent]

Get list of sound events as a mutable slice

pub fn sound(&self, index: usize) -> Option<&SsaEvent>

Get sound event at specified index

pub fn sound_mut(&mut self, index: usize) -> Option<&mut SsaEvent>

Get mutable sound event at specified index

pub fn movies(&self) -> &[SsaEvent]

Get list of movie events as a slice

pub fn movies_mut(&mut self) -> &mut [SsaEvent]

Get list of movie events as a mutable slice

pub fn movie(&self, index: usize) -> Option<&SsaEvent>

Get movie event at specified index

pub fn movie_mut(&mut self, index: usize) -> Option<&mut SsaEvent>

Get mutable movie event at specified index

pub fn commands(&self) -> &[SsaEvent]

Get list of command events as a slice

pub fn commands_mut(&mut self) -> &mut [SsaEvent]

Get list of command events as a mutable slice

pub fn command(&self, index: usize) -> Option<&SsaEvent>

Get command event at given index

pub fn command_mut(&mut self, index: usize) -> Option<&mut SsaEvent>

Get mutable command event at given index

pub fn script_info(&self) -> &SsaScriptInfo

Get script info struct

pub fn script_info_mut(&mut self) -> &mut SsaScriptInfo

Get mutable script info struct

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

Get list of styles as a slice

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

Get list of styles as a mutable slice

pub fn fonts(&self) -> &[SubStationFont]

Get list of fonts as a slice

pub fn fonts_mut(&mut self) -> &mut [SubStationFont]

Get list of fonts as a mutable slice

pub fn graphics(&self) -> &[SubStationGraphic]

Get list of graphics as a slice

pub fn graphics_mut(&mut self) -> &mut [SubStationGraphic]

Get list of graphics as a mutable slice

Trait Implementations

impl Debug for SsaSubtitle

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

Formats the value using the given formatter.

impl Default for SsaSubtitle

fn default() -> Self

Returns the “default value” for a type.

impl Display for SsaSubtitle

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

Formats the value using the given formatter.

impl From<&AssSubtitle> for SsaSubtitle

fn from(value: &AssSubtitle) -> Self

Converts to this type from the input type.

impl From<&SsaSubtitle> for AssSubtitle

fn from(value: &SsaSubtitle) -> Self

Converts to this type from the input type.

impl From<&SsaSubtitle> for SubRipSubtitle

fn from(value: &SsaSubtitle) -> Self

Convert SubStation Alpha (.ssa) subtitles to .srt format

Replaces SubStation newline indicators (\N) with actual newlines. Additionally, converts .ssa style formatting tags to .srt formatting tags. Currently, bolded, italicised, or coloured text will be converted to their .srt counterparts. All other tags will be discarded.

impl From<&SsaSubtitle> for TimedMicroDvdSubtitle

fn from(value: &SsaSubtitle) -> 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 SsaSubtitle

fn from(value: &SubRipSubtitle) -> Self

Convert SubRip (.srt) subtitle to .ssa format.

This will replace newlines and convert HTML formatting tags (<b>, <i>, etc.) into .ssa style formatting tags

impl From<&TimedMicroDvdSubtitle> for SsaSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

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<AssSubtitle> for SsaSubtitle

fn from(value: AssSubtitle) -> Self

Converts to this type from the input type.

impl From<PlainSubtitle> for SsaSubtitle

fn from(value: PlainSubtitle) -> Self

Converts to this type from the input type.

impl From<SsaSubtitle> for AssSubtitle

fn from(value: SsaSubtitle) -> Self

Converts to this type from the input type.

impl From<SsaSubtitle> for SubRipSubtitle

fn from(value: SsaSubtitle) -> 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 SsaSubtitle

fn from(value: SubRipSubtitle) -> 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<TimedSubtitleFile> for SsaSubtitle

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

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 SsaSubtitle

type Event = SsaEvent

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) -> &[SsaEvent]

Get list of events as a slice

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

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 SsaSubtitle

fn strip_formatting(&mut self)

Strip formatting tags from lines in addition to deleting styles

impl TimedSubtitle for SsaSubtitle

fn shift(&mut self, delta: TimeDelta)

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

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