Skip to main content

NoopAudioPlayer

Struct NoopAudioPlayer 

Source
pub struct NoopAudioPlayer { /* private fields */ }
Expand description

The player used when no backend is installed.

It still allocates real SoundIds and VoiceIds and remembers the volume and bus settings written to it, so app logic and settings screens behave identically with and without a device.

Implementations§

Source§

impl NoopAudioPlayer

Source

pub fn new() -> NoopAudioPlayer

Creates a player that accepts everything and produces no sound.

Trait Implementations§

Source§

impl AudioPlayer for NoopAudioPlayer

Source§

fn load_clip(&self, _clip: AudioClip) -> Result<SoundId, AudioError>

Hands an already-decoded clip to the engine.
Source§

fn play(&self, _id: SoundId, _params: PlaybackParams)

Starts a one-shot voice. Re-triggering the same clip layers a new voice rather than restarting the old one.
Source§

fn play_loop(&self, id: SoundId, _params: PlaybackParams) -> VoiceId

Starts a looping voice and returns its handle.
Source§

fn stop(&self, _id: SoundId)

Stops every voice playing id.
Source§

fn stop_voice(&self, _voice: VoiceId)

Stops one voice.
Source§

fn set_master_volume(&self, volume: f32)

Sets the gain applied to every bus.
Source§

fn master_volume(&self) -> f32

The current master gain.
Source§

fn set_bus_volume(&self, bus: AudioBus, volume: f32)

Sets one bus’s gain.
Source§

fn bus_volume(&self, bus: AudioBus) -> f32

One bus’s gain.
Source§

fn set_bus_enabled(&self, bus: AudioBus, enabled: bool)

Mutes or unmutes a bus. This is the “sound on” / “music on” toggle; muting leaves voices running so unmuting resumes mid-track.
Source§

fn bus_enabled(&self, bus: AudioBus) -> bool

Whether a bus is audible.
Source§

fn load(&self, bytes: &[u8]) -> Result<SoundId, AudioError>

Decodes bytes and loads the result. Read more
Source§

fn unload(&self, _id: SoundId)

Releases a clip. Voices already playing it are stopped.
Source§

fn stop_all(&self)

Stops every voice on every bus.
Source§

fn set_voice_params(&self, _voice: VoiceId, _params: PlaybackParams)

Retunes a voice while it plays — a looping engine note that follows speed, for instance.
Source§

fn suspend(&self)

Releases the output device without discarding loaded clips — call it when the app goes to the background.
Source§

fn resume(&self)

Re-acquires the output device after suspend.
Source§

fn is_available(&self) -> bool

Whether a real device is behind this handle. The no-op default reports false, so an app can honestly grey out its audio settings.
Source§

impl Default for NoopAudioPlayer

Source§

fn default() -> NoopAudioPlayer

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.