Struct PlaybackParams 

pub struct PlaybackParams {
    pub volume: f32,
    pub rate: f32,
    pub pan: f32,
    pub bus: AudioBus,
}

How one voice should sound.

Build with the chained setters — PlaybackParams::new().volume(0.4).pan(-0.3) reads like the named arguments a Compose call site would use.

Fields

volume: f32

Linear gain. 1.0 is the clip’s recorded level.

rate: f32

Playback rate, which shifts pitch with it. 1.0 is the recorded pitch, 2.0 is an octave up.

pan: f32

Stereo position from -1.0 (hard left) through 0.0 to 1.0.

bus: AudioBus

The mix bus this voice belongs to.

Implementations

impl PlaybackParams

pub const DEFAULT: PlaybackParams

The neutral parameters: unity gain, recorded pitch, centred, effects bus.

pub const MIN_RATE: f32 = 0.05

The slowest rate a backend honours.

pub const MAX_RATE: f32 = 8.0

The fastest rate a backend honours.

pub const MAX_VOLUME: f32 = 4.0

The loudest gain a backend honours, leaving room to amplify a quiet clip.

pub const fn new() -> PlaybackParams

The neutral parameters. Same as PlaybackParams::DEFAULT.

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

Sets the linear gain.

pub fn rate(self, rate: f32) -> PlaybackParams

Sets the playback rate (and with it the pitch).

pub fn pan(self, pan: f32) -> PlaybackParams

Sets the stereo position.

pub fn bus(self, bus: AudioBus) -> PlaybackParams

Sets the mix bus.

pub fn pitch_semitones(self, semitones: f32) -> PlaybackParams

Sets the rate from a pitch offset in equal-tempered semitones.

A rising combo counter reads better as pitch_semitones(combo as f32) than as a hand-computed ratio.

pub fn sanitized(self) -> PlaybackParams

Clamps every field into the range backends honour and scrubs NaN.

Backends call this before handing parameters to the audio thread, which is why a NaN rate from app arithmetic cannot wedge a voice.

pub fn gains(self) -> (f32, f32)

Constant-power left/right gains for these parameters, volume included.

Computed on the caller’s thread so the audio callback only multiplies.

Trait Implementations

impl Clone for PlaybackParams

fn clone(&self) -> PlaybackParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PlaybackParams

impl Debug for PlaybackParams

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

Formats the value using the given formatter.

impl Default for PlaybackParams

fn default() -> PlaybackParams

Returns the “default value” for a type.

impl PartialEq for PlaybackParams

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlaybackParams