Struct AudioPlayerGenerated 

pub struct AudioPlayerGenerated;

Available on target_os=none only.

Sample struct type generated by the audio_player! macro, showing methods and associated constants.

This page serves as the reference for what a generated audio player type provides. For first-time readers, start with the audio_player module documentation, then return here for a complete list of available methods and associated constants.

Auto-generated.

Implementations

impl AudioPlayerGenerated

pub const SAMPLE_RATE_HZ: u32 = VOICE_22050_HZ

Sample rate used for PCM playback by this generated player type.

pub const INITIAL_VOLUME: Volume = Volume::MAX

Initial runtime volume relative to Self::MAX_VOLUME.

pub const MAX_VOLUME: Volume = Volume::MAX

Runtime volume ceiling for this generated player type.

pub const fn samples_ms(duration_ms: u32) -> usize

Returns how many samples are needed for a duration in milliseconds at this player’s sample rate.

pub const fn silence<const SAMPLE_COUNT: usize>() -> AudioClipBuf<{ Self::SAMPLE_RATE_HZ }, SAMPLE_COUNT>

Creates a silent clip at this player’s sample rate.

See the audio_player module docs for usage.

pub const fn tone<const SAMPLE_COUNT: usize>( frequency_hz: u32, ) -> AudioClipBuf<{ Self::SAMPLE_RATE_HZ }, SAMPLE_COUNT>

Creates a sine-wave clip at this player’s sample rate.

See the audio_player module docs for usage.

pub fn new( data_pin: Peri<'static, PIN_8>, bit_clock_pin: Peri<'static, PIN_9>, word_select_pin: Peri<'static, PIN_10>, pio: Peri<'static, PIO1>, dma: Peri<'static, DMA_CH0>, spawner: Spawner, ) -> Result<&'static Self>

Creates and spawns the generated audio player instance.

See the audio_player module docs for usage.

pub fn play<const CLIP_COUNT: usize>( &self, audio_clips: [&'static AudioClip<{ Self::SAMPLE_RATE_HZ }>; CLIP_COUNT], at_end: AtEnd, )

Starts playback of one or more static audio clips.

See the audio_player module docs for usage.

pub fn stop(&self)

Stops current playback as soon as possible.

See the audio_player module docs for usage.

pub fn set_volume(&self, volume: Volume)

Sets runtime playback volume relative to Self::MAX_VOLUME.

See the audio_player module docs for usage.

pub fn volume(&self) -> Volume

Returns the current runtime playback volume relative to Self::MAX_VOLUME.

See the audio_player module docs for usage.