Struct Commands 

pub struct Commands<'a> { /* private fields */ }

Commands applied at one moment: see MixerHandle::now and MixerHandle::at.

Implementations

impl Commands<'_>

pub fn set_effects(self, bus: BusId, effects: &[Effect]) -> Result<()>

pub fn set_effect( self, bus: BusId, slot: usize, effect: Effect, fade: Fade, ) -> Result<()>

impl Commands<'_>

pub fn set_routing(self, settings: &[BusRouting]) -> Result<RoutingId>

impl Commands<'_>

pub fn play(self, sound: impl Into<Sound>, play: &Play) -> Result<VoiceId>

Starts a voice and returns its id. Fails if the sound has more than two channels, a loop region is outside it, or the command queue is full.

pub fn stop(self, voice: VoiceId, fade: Fade) -> Result<()>

Stops a voice, fading it out first. Unknown or ended voices are ignored.

pub fn stop_all(self, fade: Fade) -> Result<()>

pub fn set_gain(self, voice: VoiceId, gain: f32, fade: Fade) -> Result<()>

pub fn set_pan(self, voice: VoiceId, pan: f32, fade: Fade) -> Result<()>

Pans a voice, from -1 (left) to 1 (right).

pub fn set_rate(self, voice: VoiceId, rate: f32, fade: Fade) -> Result<()>

Changes a voice’s playback rate, which changes speed and pitch together, over the fade. 1/16..=8.

pub fn set_pitch(self, voice: VoiceId, semitones: f32, fade: Fade) -> Result<()>

Changes a voice’s pitch offset in semitones (fractions are cents) over the fade. -48..=48.

pub fn set_position( self, voice: VoiceId, position: [f32; 2], fade: Fade, ) -> Result<()>

pub fn pause(self, voice: VoiceId, fade: Fade) -> Result<()>

pub fn set_emitter( self, voice: VoiceId, emitter: Emitter, fade: Fade, ) -> Result<()>

Enable/update permanent point-source mode, using the listener at application time. Stereo collapses immediately; fade only ramps spatial parameters.

pub fn set_listener(self, listener: Listener, fade: Fade) -> Result<()>

Update every spatial voice, including paused voices and fading tails.

pub fn resume(self, voice: VoiceId, fade: Fade) -> Result<()>

pub fn pause_bus(self, bus: BusId, fade: Fade) -> Result<()>

pub fn resume_bus(self, bus: BusId, fade: Fade) -> Result<()>

pub fn set_bus_gain(self, bus: BusId, gain: f32, fade: Fade) -> Result<()>

Sets a bus’s gain; BusId::MASTER sets the master gain.