Struct amethyst_audio::output::Output

pub struct Output { /* fields omitted */ }

A speaker(s) through which audio can be played.

By convention, the default output is stored as a resource in the World.

Implementations

impl Output

pub fn name(&self) -> String

Gets the name of the output

pub fn try_play_once(
    &self,
    source: &Source,
    volume: f32
) -> Result<(), DecoderError>

Play a sound once. A volume of 1.0 is unchanged, while 0.0 is silent.

This will return an Error if the loaded audio file in source could not be decoded.

pub fn play_once(&self, source: &Source, volume: f32)

Play a sound once. A volume of 1.0 is unchanged, while 0.0 is silent.

This may silently fail, in order to get error information use try_play_once.

pub fn play_n_times(&self, source: &Source, volume: f32, n: u16)

Play a sound n times. A volume of 1.0 is unchanged, while 0.0 is silent.

This may silently fail, in order to get error information use try_play_n_times.

pub fn try_play_n_times(
    &self,
    source: &Source,
    volume: f32,
    n: u16
) -> Result<(), DecoderError>

Play a sound n times. A volume of 1.0 is unchanged, while 0.0 is silent.

This will return an Error if the loaded audio file in source could not be decoded.

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Output

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

Formats the value using the given formatter.

impl Default for Output

Convenience method for opening the default output device.

Since most modern hardware features audio output, this implementation fails if a device can't be initialized. Use an alternative initialization scheme if running on hardware without an integrated audio chip.

fn default() -> Self

Returns the "default value" for a type.