Enum SoundSource 

pub enum SoundSource {
    Generic(GenericSource),
    Spatial(SpatialSource),
}

See module docs.

Variants

Generic(GenericSource)

See generic module docs.

Spatial(SpatialSource)

See spatial module docs.

Implementations

impl SoundSource

pub fn spatial(&self) -> &SpatialSource

Tries to “cast” sound source to spatial source. It will panic if this is not spatial source. This is useful method for situations where you definitely know that source is spatial. So there is no need to use pattern matching to take reference as a spatial source.

pub fn spatial_mut(&mut self) -> &mut SpatialSource

Tries to “cast” sound source to spatial source. It will panic if this is not spatial source. This is useful method for situations where you definitely know that source is spatial. So there is no need to use pattern matching to take reference as a spatial source.

Methods from Deref<Target = GenericSource>

pub const NAME: &'static str = "name"

pub const BUFFER: &'static str = "buffer"

pub const PANNING: &'static str = "panning"

pub const PITCH: &'static str = "pitch"

pub const GAIN: &'static str = "gain"

pub const LOOPING: &'static str = "looping"

pub const RESAMPLING_MULTIPLIER: &'static str = "resampling_multiplier"

pub const STATUS: &'static str = "status"

pub const PLAY_ONCE: &'static str = "play_once"

pub fn set_name<N: AsRef<str>>(&mut self, name: N)

Sets new name of the sound source.

pub fn name(&self) -> &str

Returns the name of the sound source.

pub fn name_owned(&self) -> String

Returns the name of the sound source.

pub fn set_buffer( &mut self, buffer: Option<SoundBufferResource>, ) -> Result<Option<SoundBufferResource>, SoundError>

Changes buffer of source. Returns old buffer. Source will continue playing from beginning, old position will be discarded.

pub fn buffer(&self) -> Option<SoundBufferResource>

Returns current buffer if any.

pub fn set_play_once(&mut self, play_once: bool)

Marks buffer for single play. It will be automatically destroyed when it will finish playing.

Notes

Make sure you not using handles to “play once” sounds, attempt to get reference of “play once” sound may result in panic if source already deleted. Looping sources will never be automatically deleted because their playback never stops.

pub fn is_play_once(&self) -> bool

Returns true if this source is marked for single play, false - otherwise.

pub fn set_gain(&mut self, gain: f32) -> &mut Self

Sets new gain (volume) of sound. Value should be in 0..1 range, but it is not clamped and larger values can be used to “overdrive” sound.

Notes

Physical volume has non-linear scale (logarithmic) so perception of sound at 0.25 gain will be different if logarithmic scale was used.

pub fn gain(&self) -> f32

Returns current gain (volume) of sound. Value is in 0..1 range.

pub fn set_panning(&mut self, panning: f32) -> &mut Self

Sets panning coefficient. Value must be in -1..+1 range. Where -1 - only left channel will be audible, 0 - both, +1 - only right.

pub fn panning(&self) -> f32

Returns current panning coefficient in -1..+1 range. For more info see set_panning. Default value is 0.

pub fn status(&self) -> Status

Returns status of sound source.

pub fn play(&mut self) -> &mut Self

Changes status to Playing.

pub fn pause(&mut self) -> &mut Self

Changes status to Paused

pub fn set_looping(&mut self, looping: bool) -> &mut Self

Enabled or disables sound looping. Looping sound will never stop by itself, but can be stopped or paused by calling stop or pause methods. Useful for music, ambient sounds, etc.

pub fn is_looping(&self) -> bool

Returns looping status.

pub fn set_pitch(&mut self, pitch: f64) -> &mut Self

Sets sound pitch. Defines “tone” of sounds. Default value is 1.0

pub fn pitch(&self) -> f64

Returns pitch of sound source.

pub fn stop(&mut self) -> Result<(), SoundError>

Stops sound source. Automatically rewinds streaming buffers.

pub fn playback_time(&self) -> Duration

Returns playback duration.

pub fn set_playback_time(&mut self, time: Duration)

Sets playback duration.

Trait Implementations

impl Clone for SoundSource

fn clone(&self) -> SoundSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundSource

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

Formats the value using the given formatter.

impl Default for SoundSource

fn default() -> Self

Returns the “default value” for a type.

impl Deref for SoundSource

fn deref(&self) -> &Self::Target

Returns shared reference to generic source of each sound source variant. It is possible because Spatial sources are composed using generic source.

type Target = GenericSource

The resulting type after dereferencing.

impl DerefMut for SoundSource

fn deref_mut(&mut self) -> &mut Self::Target

Returns mutable reference to generic source of each sound source variant. It is possible because Spatial sources are composed using generic source.

impl Inspect for SoundSource

fn properties(&self) -> Vec<PropertyInfo<'_>>

Returns information about “public” properties.

impl Visit for SoundSource

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult