Struct gstreamer_audio::StreamVolume

pub struct StreamVolume { /* private fields */ }

This interface is implemented by elements that provide a stream volume. Examples for such elements are volume and playbin.

Applications can use this interface to get or set the current stream volume. For this the “volume” glib::Object property can be used or the helper functions StreamVolumeExt::set_volume() and StreamVolumeExt::volume(). This volume is always a linear factor, i.e. 0.0 is muted 1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to a different format by using convert_volume(). Volume sliders should usually use a cubic volume.

Separate from the volume the stream can also be muted by the “mute” glib::Object property or StreamVolumeExt::set_mute() and StreamVolumeExt::is_muted().

Elements that provide some kind of stream volume should implement the “volume” and “mute” glib::Object properties and handle setting and getting of them properly. The volume property is defined to be a linear volume factor.

Properties

mute

Readable | Writeable

volume

Readable | Writeable

Implements

StreamVolumeExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl StreamVolume

pub const NONE: Option<&'static StreamVolume> = None

pub fn convert_volume( from: StreamVolumeFormat, to: StreamVolumeFormat, val: f64, ) -> f64

from

StreamVolumeFormat to convert from

to

StreamVolumeFormat to convert to

val

Volume in from format that should be converted

Returns

the converted volume

Trait Implementations

impl Clone for StreamVolume

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for StreamVolume

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

Formats the value using the given formatter.

impl HasParamSpec for StreamVolume

type ParamSpec = ParamSpecObject

type SetValue = StreamVolume

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, StreamVolume>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StreamVolume

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StreamVolume

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 + PartialOrd,

Restrict a value to a certain interval.

impl<OT: ObjectType> PartialEq<OT> for StreamVolume

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

impl<OT: ObjectType> PartialOrd<OT> for StreamVolume

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

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

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

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

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

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

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

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

impl StaticType for StreamVolume

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StreamVolume

impl Send for StreamVolume

impl Sync for StreamVolume