Struct PulseSampleClip 

pub struct PulseSampleClip { /* private fields */ }

A Lua-friendly sample clip that renders into offline audio exports.

Implementations

impl PulseSampleClip

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

Creates a sample clip from an audio file path.

pub fn with_playback_rate(self, playback_rate: f32) -> PulseResult<Self>

Sets sample playback rate. Values above 1 play faster and higher.

pub fn with_gain(self, gain: f32) -> PulseResult<Self>

Sets sample gain before the clip is inserted into the composition.

pub fn with_pitch_shift(self, semitones: f32) -> PulseResult<Self>

Shifts pitch in semitones without intentionally changing duration.

pub fn with_time_stretch(self, factor: f32) -> PulseResult<Self>

Stretches time without intentionally changing pitch.

pub fn with_start_at(self, start_at: f32) -> PulseResult<Self>

Sets clip start offset relative to the song or phrase placement.

pub fn with_track(self, track_name: impl Into<String>) -> Self

Sets the track name used when this sample clip is inserted into a song or phrase.

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

Sets track-level volume for the sample clip.

pub fn with_pan(self, pan: f32) -> PulseResult<Self>

Sets track-level stereo pan for the sample clip.

pub fn with_effect(self, effect: PulseEffect) -> Self

Appends one track-level effect to this sample clip.

pub fn with_slice(self, start: f32, end: f32) -> PulseResult<Self>

Selects a source audio time range before pitch, stretch, gain, and rate transforms.

pub fn with_reverse(self) -> Self

Reverses the selected source sample range before fades, pitch, stretch, gain, and rate transforms.

pub fn with_loop_for(self, duration: f32) -> PulseResult<Self>

Repeats the selected source sample range to a fixed offline render duration.

pub fn with_normalize(self) -> Self

Normalizes the selected source sample peak before fades and final gain.

pub fn with_fade_in(self, duration: f32) -> PulseResult<Self>

Applies a fade-in to the rendered source sample before pitch, stretch, gain, and rate transforms.

pub fn with_fade_out(self, duration: f32) -> PulseResult<Self>

Applies a fade-out to the rendered source sample before pitch, stretch, gain, and rate transforms.

pub fn path(&self) -> &str

Returns the source audio file path.

pub fn playback_rate(&self) -> f32

Returns the sample playback rate.

pub fn start_at(&self) -> f32

Returns clip start offset relative to the song or phrase placement.

pub fn track_name(&self) -> Option<&str>

Returns the explicit track name, if one was set.

pub fn volume(&self) -> f32

Returns track-level volume.

pub fn pan(&self) -> f32

Returns track-level pan.

pub fn effects(&self) -> &[PulseEffect]

Returns track-level effects in insertion order.

pub fn slice_range(&self) -> Option<(f32, f32)>

Returns selected source slice range, if any.

pub fn reverse(&self) -> bool

Returns whether the selected source sample range is reversed before rendering.

pub fn loop_for(&self) -> Option<f32>

Returns the requested offline loop duration, if any.

pub fn normalize(&self) -> bool

Returns whether the rendered source sample is normalized before final gain.

pub fn fade_in(&self) -> f32

Returns fade-in duration in seconds.

pub fn fade_out(&self) -> f32

Returns fade-out duration in seconds.

pub fn duration(&self) -> PulseResult<f32>

Returns rendered clip duration after sample transforms and playback rate.

Trait Implementations

impl Clone for PulseSampleClip

fn clone(&self) -> PulseSampleClip

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulseSampleClip

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

Formats the value using the given formatter.

impl PartialEq for PulseSampleClip

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

impl UserData for PulseSampleClip

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.