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>
impl<'a, 'b, S: AppState> VolumeEffects<'a, 'b, S>
Sourcepub fn get_level(self, stream: VolumeStream) -> EffectBuilder<'a, 'b, S>
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.
Sourcepub fn set_level(self, request: VolumeSetRequest) -> EffectBuilder<'a, 'b, S>
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.
Sourcepub fn adjust_level(
self,
request: VolumeAdjustRequest,
) -> EffectBuilder<'a, 'b, S>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.