embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

ControlMonitor

Struct ControlMonitor 

Source
pub struct ControlMonitor<'d> { /* private fields */ }
Expand description

Control status change monitor.

Await Self::changed, then read the updated settings with Self::muted, Self::volume and Self::sample_rate_hz.

Implementations§

Source§

impl<'d> ControlMonitor<'d>

Source

pub fn muted(&self) -> bool

Whether the host has muted the stream: the master channel, or every audio channel. A stream that honours it plays or sends silence.

Source

pub fn volume(&self, channel: Channel) -> Option<Volume>

Returns the channel volume with the master volume applied.

Returns Volume::Muted if the master or channel is muted or set to silence (-∞ dB). Returns None if the channel is absent or neither it nor the master has controls.

Source

pub fn sample_rate_hz(&self) -> u32

Get the streaming endpoint’s sample rate in Hz. Before the host sets one — and again after a bus reset — it is the first advertised rate.

Source

pub async fn changed(&self)

Wait for the control settings to change. Single consumer: await this from at most one task.

Auto Trait Implementations§

§

impl<'d> !RefUnwindSafe for ControlMonitor<'d>

§

impl<'d> !UnwindSafe for ControlMonitor<'d>

§

impl<'d> Freeze for ControlMonitor<'d>

§

impl<'d> Send for ControlMonitor<'d>

§

impl<'d> Sync for ControlMonitor<'d>

§

impl<'d> Unpin for ControlMonitor<'d>

§

impl<'d> UnsafeUnpin for ControlMonitor<'d>

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 = !

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.