Skip to main content

AudioPlayerGenerated

device_envoy_esp::audio_player::audio_player_generated

Struct AudioPlayerGenerated 

Source 
pub struct AudioPlayerGenerated;
Expand description

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.

The macro also generates AudioPlayerGeneratedPlayable, a trait-object alias for clip sources at the same sample rate.

Auto-generated.

Implementations§

Source§

impl AudioPlayerGenerated

Source

pub const SAMPLE_RATE_HZ: u32 = VOICE_22050_HZ

Sample rate used for playback by this generated player type.

See the audio_player module docs for usage.

Source

pub const MAX_CLIPS: usize = 16

Maximum number of clips accepted by play(...).

Source

pub const INITIAL_VOLUME: Volume = Volume::MAX

Initial runtime volume relative to Self::MAX_VOLUME.

Source

pub const MAX_VOLUME: Volume = Volume::MAX

Runtime volume ceiling for this generated player type.

Source

pub fn new( data_pin: impl Sized, bit_clock_pin: impl Sized, word_select_pin: impl Sized, i2s: impl Sized, dma: impl Sized, spawner: Spawner, ) -> Result<&'static Self>

Creates and spawns the generated audio player instance.

See the audio_player module docs for usage.

Trait Implementations§

Source§

impl AudioPlayer<VOICE_22050_HZ> for AudioPlayerGenerated

Source§

const SAMPLE_RATE_HZ: u32 = VOICE_22050_HZ

Sample rate in hertz for this generated player type.
Source§

const MAX_CLIPS: usize = 16

Maximum number of clips accepted by play(...) for this generated type.
Source§

const INITIAL_VOLUME: Volume = Volume::MAX

Initial runtime volume relative to Self::MAX_VOLUME.
Source§

const MAX_VOLUME: Volume = Volume::MAX

Runtime volume ceiling for this generated player type.
Source§

fn play<I>(&self, audio_clips: I, at_end: AtEnd)
where I: IntoIterator<Item = &'static dyn Playable<VOICE_22050_HZ>>,

Starts playback of one or more static audio clips. Read more
Source§

fn stop(&self)

Stops current playback as soon as possible. Read more
Source§

async fn wait_until_stopped(&self)

Waits until playback is stopped. Read more
Source§

fn set_volume(&self, volume: Volume)

Sets runtime playback volume relative to the generated player’s max volume. Read more
Source§

fn volume(&self) -> Volume

Returns the current runtime playback volume relative to max volume. 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.