Struct V4Format 

pub struct V4Format { /* private fields */ }

V4Format

The Second part of any Advanced SubStation Alpha file is V4Format. This is the part which has fields separated by comma which specify the format, styling, encoding colors and many other important parts of the the .ass file.

Implementations

impl V4Format

pub fn set_v4(&mut self, v4: V4Format) -> &mut V4Format

Set V4 from a V4 Struct.

Examples found in repository

examples/create_default_subtitles.rs (line 11)

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 18)

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 35)

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 36)

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 V4Format

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

set the name for the V4 field. The name of the Style. Case sensitive. Cannot include commas

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

set the fontname for the V4 field. The fontname as used by Windows. Case-sensitive.

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

set the fontsize for the V4 field.

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

set the primarycolour for the V4 field.

use ass_parser::{AssFile, ScriptInfo, V4Format, Events, AssFileOptions};
use hex_color::HexColor;
 
fn main() {
    let mut ass_file = AssFile::new();
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);
 
    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(Events::default());
 
    AssFile::save_file(&ass_file, "new_subtitles.ass")
}

Examples found in repository

examples/modify_existing_ass_file.rs (line 11)

fn main() -> Result<(), std::io::Error>{
    let mut ass_file = AssFile::from_file("./examples/subtitles.ass")?;
    let dialogue = Dialogue::default()
        .set_text("Hello Friend!");
    let primary_color = AssFileOptions::get_ass_color(HexColor::RED);

    ass_file.components.v4
        .set_primarycolour(&primary_color);
        
    ass_file.components.events
        .add_dialogue(dialogue);

    AssFile::save_file(&ass_file, "sub.ass");
    println!("modified subtitles saved!");

    Ok(())
}

examples/random_colors_from_subrip.rs (line 36)

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 37)

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_secondarycolour(&mut self, value: &str) -> &mut Self

set the secondarycolour for the V4 field.

use ass_parser::{AssFile, ScriptInfo, V4Format, Events, AssFileOptions};
use hex_color::HexColor;
 
fn main() {
    let mut ass_file = AssFile::new();
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);
 
    ass_file.components.script
        .set_script(ScriptInfo::default());
 
    ass_file.components.v4
        .set_v4(V4Format::default())
        .set_secondarycolour(&hexcolor);
 
    ass_file.components.events
        .set_events(Events::default());
 
    AssFile::save_file(&ass_file, "new_subtitles.ass")
}

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

set the outlinecolour for the V4 field.

use ass_parser::{AssFile, ScriptInfo, V4Format, Events, AssFileOptions};
use hex_color::HexColor;
 
fn main() {
    let mut ass_file = AssFile::new();
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);
 
    ass_file.components.script
        .set_script(ScriptInfo::default());
 
    ass_file.components.v4
        .set_v4(V4Format::default())
        .set_outlinecolour(&hexcolor);
 
    ass_file.components.events
        .set_events(Events::default());
 
    AssFile::save_file(&ass_file, "new_subtitles.ass")
}

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

set the backcolour for the V4 field.

use ass_parser::{AssFile, ScriptInfo, V4Format, Events, AssFileOptions};
use hex_color::HexColor;
 
fn main() {
    let mut ass_file = AssFile::new();
    let hexcolor = AssFileOptions::get_ass_color(HexColor::YELLOW);
 
    ass_file.components.script
        .set_script(ScriptInfo::default());
 
    ass_file.components.v4
        .set_v4(V4Format::default())
        .set_backcolour(&hexcolor);
 
    ass_file.components.events
        .set_events(Events::default());
 
    AssFile::save_file(&ass_file, "new_subtitles.ass")
}

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

set the bold for the V4 field. This defines whether text is bold (true) or not (false). -1 is True, 0 is False. This is independant of the Italic attribute - you can have have text which is both bold and italic

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

set the italic for the V4 field. This defines whether text is italic (true) or not (false). -1 is True, 0 is False. This is independant of the bold attribute - you can have have text which is both bold and italic.

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

set the underline for the V4 field. use either of [-1 or 0] where -1 is considered True and 0 is considered False.

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

set the strikeout for the V4 field. use either of [-1 or 0] where -1 is considered True and 0 is considered False.

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

set the scalex for the V4 field. ScaleX. Modifies the width of the font. [percent]

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

set the scaley for the V4 field. ScaleX. Modifies the height of the font. [percent]

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

set the spacing for the V4 field. Extra space between characters. [pixels]

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

set the angle for the V4 field. The origin of the rotation is defined by the alignment. Can be a floating point number. [degrees]

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

set the borderstyle for the V4 field. pass either 1 or 3. where 1=Outline + drop shadow, 3=Opaque box.

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

set the outline for the V4 field. If BorderStyle is 1, then this specifies the width of the outline around the text, in pixels. Values may be 0, 1, 2, 3 or 4.

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

set the shadow for the V4 field. If BorderStyle is 1, then this specifies the depth of the drop shadow behind the text, in pixels. Values may be 0, 1, 2, 3 or 4. Drop shadow is always used in addition to an outline.

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

set the alignment for the V4 field. This sets how text is “justified” within the Left/Right onscreen margins, and also the vertical placing. Values may be 1=Left, 2=Centered, 3=Right. Add 4 to the value for a “Toptitle”. Add 8 to the value for a “Midtitle”. eg. 5 = left-justified toptitle

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

set the marginl for the V4 field. This defines the Left Margin in pixels. It is the distance from the left-hand edge of the screen.The three onscreen margins (MarginL, MarginR, MarginV) define areas in which the subtitle text will be displayed.

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

set the marginr for the V4 field. This defines the Right Margin in pixels. It is the distance from the right-hand edge of the screen. The three onscreen margins (MarginL, MarginR, MarginV) define areas in which the subtitle text will be displayed.

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

set the marginv for the V4 field. This defines the vertical Left Margin in pixels. For a subtitle, it is the distance from the bottom of the screen. For a toptitle, it is the distance from the top of the screen. For a midtitle, the value is ignored - the text will be vertically centred.

Trait Implementations

impl Clone for V4Format

fn clone(&self) -> V4Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for V4Format

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

Formats the value using the given formatter.

impl Default for V4Format

fn default() -> V4Format

V4 Set with the common ‘Default’ Format for Advanced SubStation Alpha.

impl PartialEq for V4Format

fn eq(&self, other: &V4Format) -> 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 V4Format