Struct storm::audio::SoundControl

source · [−]

#[repr(transparent)]
pub struct SoundControl(_);

Expand description

Various controls for managing an active sound.

Implementations

source

impl SoundControl

source

pub fn set_volume(&self, volume: f32, smooth: f32)

Sets the sound’s volume.

Arguments

volume - A value between [0, 1], where 0 is muted, and 1 is the sound’s original volume.
smooth - The duration in seconds to fade the change in volume from the current value to the given value.

source

pub fn pause(&self)

Pauses the sound. The sound can later be resumed.

source

pub fn resume(&self)

Resumes the sound. Only a paused sound can be resumed.

source

pub fn stop(&self)

Stops the sound. This action is irreversible.

source

pub fn is_stopped(&self) -> bool

Returns if the sound is stopped. If the sound was manually stopped or finished playing, it will be marked as stopped.

Trait Implementations

source

impl Clone for SoundControl

source

fn clone(&self) -> SoundControl

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl RefUnwindSafe for SoundControl

impl Send for SoundControl

impl Sync for SoundControl

impl Unpin for SoundControl

impl UnwindSafe for SoundControl

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct storm::audio::SoundControl

Implementations

impl SoundControl

pub fn set_volume(&self, volume: f32, smooth: f32)

Arguments

pub fn pause(&self)

pub fn resume(&self)

pub fn stop(&self)

pub fn is_stopped(&self) -> bool

Trait Implementations

impl Clone for SoundControl

fn clone(&self) -> SoundControl

fn clone_from(&mut self, source: &Self)

Auto Trait Implementations

impl RefUnwindSafe for SoundControl

impl Send for SoundControl

impl Sync for SoundControl

impl Unpin for SoundControl

impl UnwindSafe for SoundControl

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where
T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct storm::audio::SoundControl

Implementations

impl SoundControl

pub fn set_volume(&self, volume: f32, smooth: f32)

Arguments

pub fn pause(&self)

pub fn resume(&self)

pub fn stop(&self)

pub fn is_stopped(&self) -> bool

Trait Implementations

impl Clone for SoundControl

fn clone(&self) -> SoundControl

fn clone_from(&mut self, source: &Self)

Auto Trait Implementations

impl RefUnwindSafe for SoundControl

impl Send for SoundControl

impl Sync for SoundControl

impl Unpin for SoundControl

impl UnwindSafe for SoundControl

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,