Skip to main content

AudioCommand

kui_core::audio

Enum AudioCommand

pub enum AudioCommand {
    Play {
        playback: PlaybackId,
        sound: SoundId,
        volume: f32,
        looped: bool,
        fade_in_ms: f32,
    },
    Stop {
        playback: PlaybackId,
        fade_ms: f32,
    },
    SetVolume {
        playback: PlaybackId,
        volume: f32,
        tween_ms: f32,
    },
    Pause {
        playback: PlaybackId,
        fade_ms: f32,
    },
    Resume {
        playback: PlaybackId,
        fade_ms: f32,
    },
    MasterVolume {
        volume: f32,
        tween_ms: f32,
    },
    Unload {
        sound: SoundId,
    },
}

Expand description

An audio intent for the frame driver. Durations are ms; volumes are linear amplitude. Drivers ignore playbacks they no longer hold.

Variants§

Play

Fields

§playback: PlaybackId

§sound: SoundId

§volume: f32

§looped: bool

§fade_in_ms: f32

Stop

Fields

§playback: PlaybackId

§fade_ms: f32

SetVolume

Fields

§playback: PlaybackId

§volume: f32

§tween_ms: f32

Pause

Fields

§playback: PlaybackId

§fade_ms: f32

Resume

Fields

§playback: PlaybackId

§fade_ms: f32

MasterVolume

Fields

§volume: f32

§tween_ms: f32

Unload

The sound was unregistered: drop any decoded copy.

Fields

§sound: SoundId

Implementations§

impl AudioCommand

pub fn kind_name(&self) -> &'static str

The command’s wire name: play, stop, setVolume, pause, resume, masterVolume, unload.

pub fn to_value(&self, h: Handles) -> Value

{kind, ...} with what the variant carries: playback (a small counter, an integer), sound (a resource id, spelled by h), volume, loop, and the durations in ms as fade_in, fade, tween.

Trait Implementations§

impl Clone for AudioCommand

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for AudioCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl PartialEq for AudioCommand

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for AudioCommand

Auto Trait Implementations§

impl Freeze for AudioCommand

impl RefUnwindSafe for AudioCommand

impl Send for AudioCommand

impl Sync for AudioCommand

impl Unpin for AudioCommand

impl UnsafeUnpin for AudioCommand

impl UnwindSafe for AudioCommand

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.