Struct Params 

#[non_exhaustive]
pub struct Params {
    pub volume: u16,
    pub looped: bool,
    pub rate: u32,
    pub balance: (u16, u16),
    pub region: Option<Region>,
}

How a voice starts.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

volume: u16

In 1/4096. Over UNITY it amplifies.

looped: bool

Starts over at its end. A region loops whether or not this is set.

rate: u32

In 16.16, held between RATE_MIN and RATE_MAX: it moves the pitch and the length together.

balance: (u16, u16)

The left and right gains, in 1/4096. A mono output plays their mean.

region: Option<Region>

What it loops, after playing what comes before once.

Implementations

impl Params

pub const fn new() -> Self

Full volume, as recorded, centred, once through.

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

At volume, in 1/4096.

pub const fn looped(self) -> Self

Starting over at its end.

pub const fn with_rate(self, rate: u32) -> Self

At rate, in 16.16.

pub const fn with_balance(self, left: u16, right: u16) -> Self

With these gains, in 1/4096.

pub const fn with_region(self, region: Region) -> Self

Looping region.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Params

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Params

impl PartialEq for Params

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Params