Struct Instances 

pub struct Instances {
    pub key: u64,
    pub max: u16,
    pub min_gap: f64,
    pub policy: OverLimit,
}

Limits for one sound: at most max voices with the same key play at once, and a new one starts no sooner than min_gap seconds after the last, so that ten coins collected together do not sum into distortion.

When max voices already play, policy decides: refuse the new voice, or stop the oldest or the quietest one with a 5 ms fade. A refused start reports MixerEvent::Limited; a start within the gap is always refused. Limits are judged with the mixer’s bound on voices and its priorities when the start is applied, so scheduled starts are judged at their own frame, and a start refused for any reason stops no voice and does not begin a gap. Only instances of no higher priority than the new voice give way to it. Each start is checked against its own gap, from the sound’s last start. The mixer remembers the last starts of up to 1024 limited sounds within any 60 seconds; a limited start beyond that is refused.

Fields

key: u64

Voices with the same key share the limits. Instances::of keys a sound by its identity, so every voice of that audio counts, also through clones and Arcs. Keys you pick yourself should be below 2^63; internal audio and event identities occupy the upper half of the key space.

max: u16

Most voices playing at once; 0 for no limit.

min_gap: f64

Seconds from one start to the next, 0..=60.

policy: OverLimit

Implementations

impl Instances

pub const fn new(key: u64) -> Self

Limits keyed by key, with no limit set yet.

pub fn of(sound: &Audio) -> Self

Limits keyed by a decoded sound’s identity, which no other audio value shares, even after this one is freed.

pub const fn max(self, max: u16) -> Self

pub const fn min_gap(self, seconds: f64) -> Self

pub const fn policy(self, policy: OverLimit) -> Self

Trait Implementations

impl Clone for Instances

fn clone(&self) -> Instances

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Instances

impl Debug for Instances

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

Formats the value using the given formatter.

impl PartialEq for Instances

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instances