Enum gstreamer_audio::StreamVolumeFormat

#[non_exhaustive]pub enum StreamVolumeFormat {
    Linear,
    Cubic,
    Db,
    // some variants omitted
}

Different representations of a stream volume. StreamVolume::convert_volume allows to convert between the different representations.

Formulas to convert from a linear to a cubic or dB volume are cbrt(val) and 20 * log10 (val).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Linear

Linear scale factor, 1.0 = 100%

Cubic

Cubic volume scale

Db

Logarithmic volume scale (dB, amplitude not power)

Trait Implementations

impl Clone for StreamVolumeFormat

fn clone(&self) -> StreamVolumeFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StreamVolumeFormat

impl Debug for StreamVolumeFormat

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

Formats the value using the given formatter.

impl Eq for StreamVolumeFormat

impl Hash for StreamVolumeFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for StreamVolumeFormat

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<StreamVolumeFormat> for StreamVolumeFormat

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<StreamVolumeFormat> for StreamVolumeFormat

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for StreamVolumeFormat

impl StructuralPartialEq for StreamVolumeFormat