Struct Speaker 

pub struct Speaker<S: Sdk> { /* private fields */ }

The SDK’s speaker.

Implementations

impl<S: Sdk> Speaker<S>

pub fn new(sdk: S) -> Self

The speaker on sdk, with its sample players made.

Trait Implementations

impl<S: Sdk> Backend for Speaker<S>

fn load_sound( &mut self, _bytes: &[u8], ) -> impl Future<Output = Result<Clip<S>, String>>

The SDK loads a sound by its path (load_sound_file): it is baked to a format only pdc writes, and no bytes come here.

fn add_sound(&mut self, samples: &SharedSamples) -> Result<Clip<S>, String>

A sample the SDK makes from a copy of the samples, at their own rate.

fn remove_sound(&mut self, sound: Clip<S>)

Stops the sample players on it, lets go of it, and frees it.

type Sound = Clip<S>

A decoded sound or track.

type Loading = Option<Result<Clip<S>, String>>

A music track or voice clip being loaded.

type Playing = Playing<S>

One playback of a sound, which stops alone.

fn load_sound_file( &mut self, file: &str, _files: &Files<'_>, ) -> impl Future<Output = Result<Clip<S>, String>>

Readies the sound file file of the manifest. By default it reads the file with files and decodes it with load_sound; a device that loads a sound from its own path says so here.

fn load_music(&mut self, path: &str) -> Self::Loading

Starts loading and decoding the music or voice file at path.

fn poll_music( &mut self, loading: &mut Self::Loading, ) -> Option<Result<Clip<S>, String>>

The track, once loading has finished (called once per frame).

fn length(&self, sound: &Clip<S>) -> Option<f64>

How long sound plays, in seconds, if that is known: it is for an OGG file loaded with load_music.

fn play(&mut self, sound: &Clip<S>, volume: f32, looped: bool) -> Playing<S>

Plays sound from the start at volume (0–1): this playback.

fn set_volume(&mut self, sound: &Clip<S>, volume: f32)

Changes the volume of sound wherever it plays.

fn stop(&mut self, sound: &Clip<S>)

Stops sound.

fn set_playing_volume(&mut self, playing: &Playing<S>, volume: f32)

Changes the volume of playing alone.

fn stop_playing(&mut self, playing: Playing<S>)

Stops playing alone: other copies of its sound play on.

fn pause(&mut self, playing: &Playing<S>) -> Result<(), Unsupported>

Stops playing so that resume goes on from where it was. Without it the player mutes the sound, which runs on silently.

fn resume(&mut self, playing: &Playing<S>) -> Result<(), Unsupported>

Goes on with playing from where pause stopped it.

fn set_rate(&mut self, sound: &Clip<S>, rate: u32) -> Result<(), Unsupported>

Sets how fast sound plays from its next play, in 16.16 fixed point (RATE_ONE plays it as recorded). Without it the sound plays at 1.0.

fn warn(&mut self, line: &str)

Says a problem of the player’s in the backend’s log, by default nowhere.

fn hold_output(&mut self, on: bool)

The system suspends the game (on) or has resumed it: a backend whose output can stop stops it here, after the player has held what sounds.

impl<S: Debug + Sdk> Debug for Speaker<S>

where S::Sample: Debug,

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

Formats the value using the given formatter.