Struct PlayOptions 

pub struct PlayOptions {
    pub looped: bool,
    pub volume: f32,
    pub deferred: bool,
}

How to play a sound: see Audio::play_with. The default plays once at the sound’s own volume, and fails with AudioError::NotStarted before audio is available.

Fields

looped: bool

Loop the whole sound until stopped.

volume: f32

Linear amplitude (1.0 is the sound’s own level, 0.0 silence).

deferred: bool

If audio hasn’t started yet (web, before the first user gesture), queue the sound and start it once audio starts, instead of failing with AudioError::NotStarted. Meant for music and ambience; a one-shot effect would play late, out of context.

Implementations

impl PlayOptions

pub fn looped() -> PlayOptions

Options for a sound that loops until stopped.

pub fn volume(self, volume: f32) -> PlayOptions

Set PlayOptions::volume.

pub fn deferred(self) -> PlayOptions

Set PlayOptions::deferred.

Trait Implementations

impl Clone for PlayOptions

fn clone(&self) -> PlayOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PlayOptions

impl Debug for PlayOptions

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

Formats the value using the given formatter.

impl Default for PlayOptions

fn default() -> PlayOptions

Returns the “default value” for a type.

impl PartialEq for PlayOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlayOptions