Struct SpatialTrackHandle

pub struct SpatialTrackHandle { /* private fields */ }

Available on crate feature dep_kira only.

Controls a mixer track.

When a SpatialTrackHandle is dropped, the corresponding mixer track will be removed.

Implementations

impl SpatialTrackHandle

pub fn state(&self) -> TrackPlaybackState

Returns the current playback state of the track.

pub fn play<D>( &mut self, sound_data: D, ) -> Result<<D as SoundData>::Handle, PlaySoundError<<D as SoundData>::Error>>

where D: SoundData,

Plays a sound.

pub fn add_sub_track( &mut self, builder: TrackBuilder, ) -> Result<TrackHandle, ResourceLimitReached>

Adds a child track to this track.

pub fn add_spatial_sub_track( &mut self, listener: impl Into<ListenerId>, position: impl Into<Value<Vector3<f32>>>, builder: SpatialTrackBuilder, ) -> Result<SpatialTrackHandle, ResourceLimitReached>

Adds a spatial child track to this track.

pub fn set_volume(&mut self, volume: impl Into<Value<Decibels>>, tween: Tween)

Sets the (post-effects) volume of the mixer track.

pub fn set_position( &mut self, position: impl Into<Value<Vector3<f32>>>, tween: Tween, )

Sets the position that audio is produced from.

pub fn set_spatialization_strength( &mut self, spatialization_strength: impl Into<Value<f32>>, tween: Tween, )

Sets how much the track’s output should be panned left or right depending on its direction from the listener.

This value should be between 0.0 and 1.0. 0.0 disables spatialization entirely.

pub fn set_send( &mut self, to: impl Into<SendTrackId>, volume: impl Into<Value<Decibels>>, tween: Tween, ) -> Result<(), NonexistentRoute>

Sets the volume of this track’s route to a send track.

This can only be used to change the volume of existing routes, not to add new routes.

pub fn pause(&mut self, tween: Tween)

Fades out the track to silence with the given tween and then pauses playback, pausing all sounds and emitters playing on this track.

pub fn resume(&mut self, tween: Tween)

Resumes playback and fades in the sound from silence with the given tween, resuming all sounds and emitters playing on this track.

pub fn resume_at(&mut self, start_time: StartTime, tween: Tween)

Resumes playback at the given start time and fades in the sound from silence with the given tween.

pub fn sound_capacity(&self) -> usize

Returns the maximum number of sounds that can play simultaneously on this track.

pub fn num_sounds(&self) -> usize

Returns the number of sounds currently playing on this track.

pub fn sub_track_capacity(&self) -> usize

Returns the maximum number of child tracks this track can have.

pub fn num_sub_tracks(&self) -> usize

Returns the number of child tracks this track has.

Trait Implementations

impl Debug for SpatialTrackHandle

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

Formats the value using the given formatter.

impl Drop for SpatialTrackHandle

fn drop(&mut self)

Executes the destructor for this type.