Struct AudioClip 

pub struct AudioClip {
    pub state: AudioPlayState,
    pub looping: bool,
    pub volume: f64,
    pub playback_rate: f64,
    /* private fields */
}

An audio clip wrapping a decoded AudioBuffer with playback control.

Fields

state: AudioPlayState

The current playback state.

get_state is public because tests/audio_clip/fn.rs reads this field from outside this crate. get_mut / set stay crate-internal.

looping: bool

Whether the clip should loop when it reaches the end.

get_looping is public because tests/audio_clip/fn.rs reads this field from outside this crate. get_mut / set stay crate-internal.

volume: f64

The volume level in the range 0.0 to 1.0.

get_volume is public because tests/audio_clip/fn.rs reads this field from outside this crate. get_mut / set stay crate-internal.

playback_rate: f64

The playback rate multiplier (1.0 = normal speed).

get_playback_rate is public because tests/audio_clip/fn.rs reads this field from outside this crate. get_mut / set stay crate-internal.

Implementations

impl AudioClip

Implements playback control for AudioClip.

pub fn create(buffer: AudioBuffer) -> AudioClip

Creates a new audio clip from a decoded buffer.

A clip carries no name: playback is driven by play / stop, which address a clip by identity rather than by label, so a name field would only ever be stored and never read.

Arguments

• AudioBuffer - The decoded audio data.

Returns

• AudioClip - The new clip.

pub fn play(&mut self, audio_context: &GameAudioContext)

Plays this clip through the given audio context.

Creates a new AudioBufferSourceNode, connects it through a gain node to the master gain, and starts playback. If already playing, does nothing.

Arguments

• &GameAudioContext - The audio context to play through.

pub fn stop(&mut self)

Stops playback of this clip and releases the source node.

pub fn update_looping(&mut self, looping: bool)

Sets whether the clip should loop.

Arguments

• bool - True to enable looping.

pub fn update_volume(&mut self, volume: f64)

Sets the volume of this clip.

Arguments

• f64 - The volume in the range 0.0 to 1.0.

pub fn update_playback_rate(&mut self, rate: f64)

Sets the playback rate multiplier.

Arguments

• f64 - The playback rate (1.0 = normal speed).

pub fn duration(&self) -> f64

Returns the duration of the audio buffer in seconds.

Returns

• f64 - The duration.

pub fn channel_count(&self) -> u32

Returns the number of channels in the audio buffer.

Returns

• u32 - The channel count.

impl AudioClip

pub fn get_state(&self) -> AudioPlayState

pub fn get_looping(&self) -> bool

pub fn get_volume(&self) -> f64

pub fn get_playback_rate(&self) -> f64

impl AudioClip

pub fn new( buffer: AudioBuffer, state: AudioPlayState, looping: bool, volume: f64, playback_rate: f64, ) -> Self

Trait Implementations

impl Clone for AudioClip

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.