Struct AudioTrack 

pub struct AudioTrack {
    pub path: String,
    pub volume: f32,
    pub start_ms: Option<u64>,
    pub end_ms: Option<u64>,
    pub loop_track: bool,
}

A background audio track to mix with the narration audio.

Tracks loop by default and play at 30% volume. Use the builder methods to customize.

Example

use narrate_this::AudioTrack;

let track = AudioTrack::new("./music.mp3")
    .volume(0.15)
    .start_at(2000) // delay by 2 seconds
    .no_loop();

Fields

path: String

File path to the audio file.

volume: f32

Volume level from 0.0 (silent) to 1.0 (full). Default: 0.3.

start_ms: Option<u64>

Optional delay before the track starts (milliseconds).

end_ms: Option<u64>

Optional end time — the track is trimmed at this point (milliseconds).

loop_track: bool

Whether to loop the track for the duration of the narration. Default: true.

Implementations

impl AudioTrack

pub fn new(path: impl Into<String>) -> Self

pub fn volume(self, volume: f32) -> Self

pub fn start_at(self, ms: u64) -> Self

pub fn end_at(self, ms: u64) -> Self

pub fn no_loop(self) -> Self

Trait Implementations

impl Clone for AudioTrack

fn clone(&self) -> AudioTrack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioTrack

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

Formats the value using the given formatter.