Struct ScriptInfo 

pub struct ScriptInfo { /* private fields */ }

The First part of any Advanced SubStation Alpha file is Script Info. This holds necessary information which include the version the resolution of subtitles etc of the .ass file.

Implementations

impl ScriptInfo

pub fn set_script(&mut self, script: ScriptInfo) -> &mut ScriptInfo

Examples found in repository

examples/create_default_subtitles.rs (line 8)

fn main() {
    let mut ass_file = AssFile::new();

    ass_file.components.script
        .set_script(ScriptInfo::default());

    ass_file.components.v4
        .set_v4(V4Format::default());

    ass_file.components.events
        .set_events(Events::default());

    AssFile::save_file(&ass_file, "default_subtitles.ass");
}

examples/color.rs (line 15)

fn main() {
    let mut ass_file = AssFile::new();

    let dialogue = Dialogue::new()
        .set_start("0:00:00:00")
        .set_end("0:00:02:00")
        .set_text("Hello Friend!")
        .set_colour(HexColor::YELLOW);

    ass_file.components.script
        .set_script(ScriptInfo::default());

    ass_file.components.v4
        .set_v4(V4Format::default());

    ass_file.components.events
        .set_events(Events::default())
        .add_dialogue(dialogue);

    AssFile::save_file(&ass_file, "new_subtitles.ass");
}

examples/random_colors_from_subrip.rs (line 30)

fn main() {
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);
    let srt_file = AssFile::from_srt("RapGod.srt");
    let mut ass_file = AssFile::new();
    let mut event = Events::default();

    for srt_seg in srt_file.iter() {
        let start = &srt_seg.start;
        let end = &srt_seg.end;
        let text = &srt_seg.text;

        let random_color:HexColor = rand::random();

        let dialogue = Dialogue::default()
            .set_start(&start)
            .set_end(&end)
            .set_text(&text)
            .set_colour(random_color);

        event.add_dialogue(dialogue);
    }
    

    ass_file.components.script
        .set_script(ScriptInfo::default());



    ass_file.components.v4
        .set_v4(V4Format::default())
        .set_primarycolour(&hexcolor);
    ass_file.components.events
        .set_events(event);

    AssFile::save_file(&ass_file, "new_subtitle.ass");
}

examples/timestamped_subtitles.rs (line 32)

fn main() -> Result<(), IndexNotFound>{
    let mut ass_file = AssFile::new();
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);

    let first_dialogue = Dialogue::default()
        .set_start("0:00:00.10")
        .set_end("0:00:00.50")
        .set_text("Hello There.");

    let second_dialogue = Dialogue::default()
        .set_start("00:00.50")
        .set_end("00:00.58")
        .set_text("Hello Friend.");

    let third_dialogue = Dialogue::default()
        .set_start("0:00:00.58")
        .set_end("0:00:01.01")
        .set_text("Goodbye Friend.");

    let events = Events::new()
        .add_first_dialogue(first_dialogue)?
        .add_dialogue(second_dialogue)
        .add_dialogue(third_dialogue)
        .create();


    ass_file.components.script
        .set_script(ScriptInfo::default())
        .set_scripttype("FFMPEG");

    ass_file.components.v4
        .set_v4(V4Format::default())
        .set_primarycolour(&hexcolor);

    ass_file.components.events
        .set_events(events);

    AssFile::save_file(&ass_file, "new_subtitles.ass");

    Ok(())

}

impl ScriptInfo

pub fn set_scripttype(&mut self, value: &str) -> &mut Self

After creating the AssFile set the scripttype of the .ass file. If you want to specify any, the default ScriptType from the original .ass file will be used. This is the SSA script format version eg. “V4.00”. It is used by SSA to give a warning if you are using a version of SSA older than the version that created the script. ASS version is “V4.00+”.

Examples found in repository

examples/timestamped_subtitles.rs (line 33)

fn main() -> Result<(), IndexNotFound>{
    let mut ass_file = AssFile::new();
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);

    let first_dialogue = Dialogue::default()
        .set_start("0:00:00.10")
        .set_end("0:00:00.50")
        .set_text("Hello There.");

    let second_dialogue = Dialogue::default()
        .set_start("00:00.50")
        .set_end("00:00.58")
        .set_text("Hello Friend.");

    let third_dialogue = Dialogue::default()
        .set_start("0:00:00.58")
        .set_end("0:00:01.01")
        .set_text("Goodbye Friend.");

    let events = Events::new()
        .add_first_dialogue(first_dialogue)?
        .add_dialogue(second_dialogue)
        .add_dialogue(third_dialogue)
        .create();


    ass_file.components.script
        .set_script(ScriptInfo::default())
        .set_scripttype("FFMPEG");

    ass_file.components.v4
        .set_v4(V4Format::default())
        .set_primarycolour(&hexcolor);

    ass_file.components.events
        .set_events(events);

    AssFile::save_file(&ass_file, "new_subtitles.ass");

    Ok(())

}

pub fn set_playresx(&mut self, value: &str) -> &mut Self

After creating the AssFile set the playresx of the .ass file.

This is the height of the screen used by the script’s author(s) when playing the script. SSA v4 will automatically select the nearest enabled setting, if you are using Directdraw playback.

If you don’t want to specify any, the default playresx from the original .ass file will be used.

pub fn set_playresy(&mut self, value: &str) -> &mut Self

After creating the AssFile set the playresy of the .ass file.

This is the height of the screen used by the script’s author(s) when playing the script. SSA v4 will automatically select the nearest enabled setting, if you are using Directdraw playback.

If you want to specify any, the default playresy from the original .ass file will be used.

pub fn set_scaledborderandshadow(&mut self, value: &str) -> &mut Self

After creating the AssFile set the scaledborderandshadow of the .ass file. If you want to specify any, the default scaledborderandshadowfrom the original .ass file will be used.

pub fn set_ycbcr_matrix(&mut self, value: &str) -> &mut Self

After creating the AssFile set the ycbcr_matrix( of the .ass file. If you want to specify any, the default ycbcr_matrix from the original .ass file will be used.

Trait Implementations

impl Clone for ScriptInfo

fn clone(&self) -> ScriptInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptInfo

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

Formats the value using the given formatter.

impl Default for ScriptInfo

fn default() -> ScriptInfo

Returns the “default value” for a type.

impl PartialEq for ScriptInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScriptInfo