Skip to main content

Mixer

Struct Mixer 

Source
pub struct Mixer {
    pub music: Bus,
    pub sfx: Bus,
    pub ambient: Bus,
    pub ui: Bus,
    pub master: Bus,
    pub limiter: Limiter,
    pub compressor: Compressor,
    pub listener_pos: Vec3,
    pub auto_duck: bool,
    /* private fields */
}
Expand description

The master audio mixer — manages buses, channels, and effects.

Fields§

§music: Bus§sfx: Bus§ambient: Bus§ui: Bus§master: Bus§limiter: Limiter§compressor: Compressor§listener_pos: Vec3§auto_duck: bool

Ducking: when SFX is playing loudly, music ducks.

Implementations§

Source§

impl Mixer

Source

pub fn new() -> Self

Source

pub fn bus_mut(&mut self, id: BusId) -> &mut Bus

Source

pub fn bus(&self, id: BusId) -> &Bus

Source

pub fn set_music_volume(&mut self, v: f32)

Source

pub fn set_sfx_volume(&mut self, v: f32)

Source

pub fn set_ambient_volume(&mut self, v: f32)

Source

pub fn set_master_volume(&mut self, v: f32)

Source

pub fn fade_music(&mut self, target: f32, secs: f32)

Source

pub fn mute_all(&mut self)

Source

pub fn unmute_all(&mut self)

Source

pub fn add_channel(&mut self, position: Vec3, bus: BusId) -> u64

Register a spatial sound channel. Returns its ID.

Source

pub fn add_oneshot_sfx(&mut self, position: Vec3, duration_s: f32) -> u64

Add a one-shot SFX at a world position.

Source

pub fn remove_channel(&mut self, id: u64)

Remove a channel by ID.

Source

pub fn get_channel_mut(&mut self, id: u64) -> Option<&mut ChannelStrip>

Source

pub fn tick(&mut self, dt: f32)

Tick all buses and channels by dt seconds.

Source

pub fn mix_frame(&mut self, channel_gains: &[(u64, f32)]) -> StereoFrame

Mix one stereo output frame from all active channels.

Source

pub fn channel_count(&self) -> usize

Number of active channels.

Source

pub fn update_auto_duck(&mut self)

Auto-duck music when SFX volume exceeds threshold.

Trait Implementations§

Source§

impl Default for Mixer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Mixer

§

impl RefUnwindSafe for Mixer

§

impl Send for Mixer

§

impl Sync for Mixer

§

impl Unpin for Mixer

§

impl UnsafeUnpin for Mixer

§

impl UnwindSafe for Mixer

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,