Struct Gain 

pub struct Gain(/* private fields */);

Relative loudness adjustment for audio clips.

Use Gain with PcmClipBuf::with_gain to make a clip louder or quieter before playback.

with_gain is intended for const clip definitions, so the adjusted samples are precomputed at compile time with no extra runtime work.

You can set gain by percent or by dB:

• Gain::percent where 100 means unchanged and values above 100 are louder.
• Gain::db where positive dB is louder and negative dB is quieter.

This is different from Volume used by max_volume, initial_volume, and set_volume, which set the absolute playback loudness behavior for the whole player.

See the audio_player module documentation for usage examples.

Implementations

impl Gain

pub const MUTE: Self

Silence.

pub const fn percent(percent: u16) -> Self

Creates a gain from percentage.

100 is unity gain. Values above 100 boost the signal.

See the audio_player module documentation for usage examples.

pub const fn db(db: i8) -> Self

Creates gain from dB with a bounded boost range.

Values above +12 dB clamp to +12 dB. Values below -96 dB clamp to -96 dB.

See PcmClipBuf::with_gain for usage.

Trait Implementations

impl Clone for Gain

fn clone(&self) -> Gain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gain

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

Formats the value using the given formatter.

impl PartialEq for Gain

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Gain

impl Eq for Gain

impl StructuralPartialEq for Gain