Struct Volume 

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

Available on target_os=none only.

Absolute playback loudness setting for the whole player.

Volume is used by the player-level controls max_volume, initial_volume, and set_volume, which set the absolute playback loudness behavior for the whole player.

This is different from Gain and AudioClipBuf::with_gain, which adjust the relative loudness of individual clips.

See the audio_player module documentation for usage examples.

Implementations

impl Volume

pub const MUTE: Self

Silence.

pub const MAX: Self

Maximum playback volume.

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

Creates a volume from a percentage of full scale.

Values above 100 are clamped to 100.

See the audio_player module documentation for usage examples.

pub const fn spinal_tap(spinal_tap: u8) -> Self

Creates a humorous “goes to 11” demo volume scale.

0..=11 maps to 0..=100% using a perceptual curve (roughly logarithmic, but not mathematically exact).

Values above 11 clamp to 11.

See the audio_player module documentation for usage examples.

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Volume

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

Formats the value using the given formatter.

impl PartialEq for Volume

fn eq(&self, other: &Volume) -> 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 Volume

impl Eq for Volume

impl StructuralPartialEq for Volume