Skip to main content

VolumeEffects

Struct VolumeEffects 

Source
pub struct VolumeEffects<'a, 'b, S: AppState> { /* private fields */ }
Expand description

Convenience builder for standard volume-control host capabilities.

Implementations§

Source§

impl<'a, 'b, S: AppState> VolumeEffects<'a, 'b, S>

Source

pub fn get_level(self, stream: VolumeStream) -> EffectBuilder<'a, 'b, S>

Reads the current level for one host volume stream.

stream identifies the logical audio stream the app cares about. Hosts map that stream to the closest platform mixer or media channel and return a VolumeLevel with level and mute state.

Source

pub fn set_level(self, request: VolumeSetRequest) -> EffectBuilder<'a, 'b, S>

Sets the level and optional mute state for one host volume stream.

request.level is a percentage-like value from 0 to 100. Hosts should clamp or reject values they cannot represent and return a typed error when the platform does not expose system volume control.

Source

pub fn adjust_level( self, request: VolumeAdjustRequest, ) -> EffectBuilder<'a, 'b, S>

Adjusts a host volume stream relative to its current level.

request.direction chooses increase, decrease, or toggle mute, and request.step controls the requested amount. Use this for keyboard-like or remote-control volume actions.

Auto Trait Implementations§

§

impl<'a, 'b, S> Freeze for VolumeEffects<'a, 'b, S>

§

impl<'a, 'b, S> !RefUnwindSafe for VolumeEffects<'a, 'b, S>

§

impl<'a, 'b, S> Send for VolumeEffects<'a, 'b, S>

§

impl<'a, 'b, S> Sync for VolumeEffects<'a, 'b, S>

§

impl<'a, 'b, S> Unpin for VolumeEffects<'a, 'b, S>

§

impl<'a, 'b, S> UnsafeUnpin for VolumeEffects<'a, 'b, S>

§

impl<'a, 'b, S> !UnwindSafe for VolumeEffects<'a, 'b, S>

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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.