Struct Volume

pub struct Volume(pub pa_volume_t);

Software volume expressed as an integer.

Tuple Fields

0: pa_volume_t

Implementations

impl Volume

pub const NORMAL: Self

A “normal” volume level.

pub const MUTED: Self

A muted volume level.

pub const MAX: Self

A maximum volume level.

pub const INVALID: Self

An invalid volume level.

pub fn is_muted(&self) -> bool

Is a muted volume level.

pub fn is_normal(&self) -> bool

Is a “normal” volume level.

pub fn is_max(&self) -> bool

Is a maximum volume level.

pub fn ui_max() -> Self

Get the recommended maximum volume to show in user facing UIs.

Note: UIs should deal gracefully with volumes greater than this value and not cause feedback loops etc. - i.e. if the volume is more than this, the UI should not limit it and push the limited value back to the server.

pub const fn is_valid(&self) -> bool

Checks if volume is valid.

pub fn clamp(&mut self)

Clamps volume to the permitted range.

pub fn multiply(a: Self, b: Self) -> Self

Multiplies two software volumes, returning the result.

This uses Volume::NORMAL as neutral element of multiplication.

This is only valid for software volumes!

pub fn divide(a: Self, b: Self) -> Self

Divides two software volumes, returning the result.

This uses Volume::NORMAL as neutral element of division. If a division by zero is tried the result will be 0.

This is only valid for software volumes!

pub fn print(&self) -> String

Pretty prints a volume.

pub fn print_db(&self) -> String

Pretty prints a volume but showing dB values.

pub fn print_verbose(&self, print_db: bool) -> String

Pretty prints a volume in a verbose way.

The volume is printed in several formats: the raw volume value, percentage, and if print_db is true, also the dB value.

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 Default for Volume

fn default() -> Self

Returns the “default value” for a type.

impl Display for Volume

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

Formats the value using the given formatter.

impl From<Volume> for VolumeDB

Converts a volume to a decibel value (amplitude, not power).

This is only valid for software volumes!

fn from(v: Volume) -> Self

Converts to this type from the input type.

impl From<Volume> for VolumeLinear

Converts a volume to a linear factor.

This is only valid for software volumes!

fn from(v: Volume) -> Self

Converts to this type from the input type.

impl From<VolumeDB> for Volume

Converts a decibel value to a volume (amplitude, not power).

This is only valid for software volumes!

fn from(v: VolumeDB) -> Self

Converts to this type from the input type.

impl From<VolumeLinear> for Volume

Converts a linear factor to a volume.

0.0 and less is muted while 1.0 is Volume::NORMAL.

This is only valid for software volumes!

fn from(v: VolumeLinear) -> Self

Converts to this type from the input type.

impl Ord for Volume

fn cmp(&self, other: &Volume) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Volume> for ChannelVolumes

fn eq(&self, v: &Volume) -> bool

Returns true if the volume of all channels are equal to the specified value.

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 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 PartialOrd for Volume

fn partial_cmp(&self, other: &Volume) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Volume

impl Eq for Volume

impl StructuralPartialEq for Volume