Struct Segment 

pub struct Segment {
    pub data: Vec<u8>,
    pub sample_width: usize,
    pub frame_rate: u32,
    pub channels: usize,
}

An immutable-in-spirit block of interleaved PCM. Methods consume and return segments the way pydub’s _spawn hands back new objects.

Fields

data: Vec<u8>

sample_width: usize

frame_rate: u32

channels: usize

Implementations

impl Segment

pub fn new( data: Vec<u8>, sample_width: usize, frame_rate: u32, channels: usize, ) -> Segment

fn spawn(&self, data: Vec<u8>) -> Segment

pub fn frame_width(&self) -> usize

pub fn empty() -> Segment

AudioSegment.empty().

pub fn silent_at(duration_ms: f64, frame_rate: u32) -> Segment

AudioSegment.silent(duration, frame_rate).

pub fn silent(duration_ms: f64) -> Segment

AudioSegment.silent(duration) — at pydub’s default 11025 Hz.

pub fn frame_count(&self) -> f64

frame_count() — whole frames, as a float.

pub fn frame_count_ms(&self, ms: f64) -> f64

frame_count(ms=...) — fractional frames for a duration.

pub fn len_ms(&self) -> i64

len(segment) in milliseconds.

fn parse_position(&self, val: f64) -> i64

fn slice_frames(&self, start: f64, end: f64) -> Segment

pub fn slice(&self, start: Option<f64>, end: Option<f64>) -> Segment

segment[start:end] in milliseconds; None is an open end.

pub fn at(&self, ms: f64) -> Segment

segment[ms] — one millisecond, deliberately not clamped.

fn get_frame(&self, index: i64) -> &[u8]

get_frame(index).

pub fn repeat(&self, n: i64) -> Segment

segment * n for an integer n.

pub fn gain(&self, db: f64) -> Segment

segment + db / segment - db — apply_gain.

pub fn set_sample_width(self, sample_width: usize) -> Segment

pub fn set_frame_rate(self, frame_rate: u32) -> Segment

pub fn set_channels(self, channels: usize) -> Segment

pub fn sync(a: Segment, b: Segment) -> (Segment, Segment)

AudioSegment._sync(a, b).

pub fn append(self, other: Segment) -> Segment

self + other — append(other, crossfade=0).

pub fn overlay(self, seg: Segment, position: i64) -> Segment

overlay(seg, position) with pydub’s defaults (no loop, one pass).

pub fn fade( &self, to_gain: f64, from_gain: f64, start: Option<f64>, end: Option<f64>, duration: Option<f64>, ) -> Segment

fade(to_gain, from_gain, start, end, duration).

pub fn fade_in(&self, duration_ms: f64) -> Segment

pub fn fade_out(&self, duration_ms: f64) -> Segment

pub fn split_to_mono(&self) -> Vec<Segment>

split_to_mono() for mono and stereo.

pub fn apply_gain_stereo(&self, left_gain: f64, right_gain: f64) -> Segment

effects.apply_gain_stereo(left_gain, right_gain).

pub fn pan(&self, pan_amount: f64) -> Segment

effects.pan(pan_amount) — not equal-power; pydub’s own formula.

fn samples_i16(&self) -> Vec<i16>

fn spawn_i16(&self, s: &[i16]) -> Segment

pub fn low_pass_filter(&self, cutoff: f64) -> Segment

effects.low_pass_filter(cutoff) — single pole, as pydub has it.

pub fn high_pass_filter(&self, cutoff: f64) -> Segment

effects.high_pass_filter(cutoff).

pub fn from_file(path: &Path) -> Result<Segment, AudioError>

AudioSegment.from_file(path): WAVs by name are read directly, everything else goes through ffmpeg exactly as pydub drives it.

pub fn export_wav(&self, path: &Path) -> Result<()>

export(path, format="wav") with no codec or parameters — Python’s wave module writes the file, no ffmpeg involved.

pub fn wav_bytes(&self) -> Vec<u8>

The bytes wave.open(f, "wb") produces for this segment.

pub fn export_ffmpeg( &self, path: &Path, format: &str, parameters: &[&str], ) -> Result<(), AudioError>

export(path, format=fmt, parameters=...) through ffmpeg: a temporary WAV in, ffmpeg -y -f wav -i tmp [params] -f fmt out — the exact command pydub builds, so the encoded bytes match.

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.

impl PartialEq for Segment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Segment