[−]Struct gstreamer_audio::StreamVolume

[+] Show declaration

pub struct StreamVolume(_, _);

[−]

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" gobject::Object property can be used or the helper functions StreamVolume::set_volume and StreamVolume::get_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 StreamVolume::convert_volume. Volume sliders should usually use a cubic volume.

Separate from the volume the stream can also be muted by the "mute" gobject::Object property or StreamVolume::set_mute and StreamVolume::get_mute.

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

Implements

StreamVolumeExt

Methods

`impl StreamVolume`[src][−]

`pub fn convert_volume( from: StreamVolumeFormat, to: StreamVolumeFormat, val: f64 ) -> f64`[src][−]

Returns

the converted volume

[−]Struct gstreamer_audio::StreamVolume

Implements

Methods

impl StreamVolume[src][−]

pub fn convert_volume( from: StreamVolumeFormat, to: StreamVolumeFormat, val: f64) -> f64[src][−]

from

to

val

Returns

Trait Implementations

impl Clone for StreamVolume[+]

fn clone(&self) -> StreamVolume[−]

fn clone_from(&mut self, source: &Self)1.0.0[src][−]

impl Debug for StreamVolume[+]

fn fmt(&self, f: &mut Formatter) -> Result[−]

impl Eq for StreamVolume

impl Hash for StreamVolume[+]

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

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

impl Ord for StreamVolume[+]

fn cmp(&self, other: &StreamVolume) -> Ordering[−]

[+] Expand attributes#[must_use] fn max(self, other: Self) -> Self1.21.0[src][−]

[+] Expand attributes#[must_use] fn min(self, other: Self) -> Self1.21.0[src][−]

[+] Expand attributes#[must_use] fn clamp(self, min: Self, max: Self) -> Self[src][−]

impl<T: ObjectType> PartialEq<T> for StreamVolume[+]

fn eq(&self, other: &T) -> bool[−]

[+] Expand attributes#[must_use] fn ne(&self, other: &Rhs) -> bool1.0.0[src][−]

impl<T: ObjectType> PartialOrd<T> for StreamVolume[+]

fn partial_cmp(&self, other: &T) -> Option<Ordering>[−]

[+] Expand attributes#[must_use] fn lt(&self, other: &Rhs) -> bool1.0.0[src][−]

[+] Expand attributes#[must_use] fn le(&self, other: &Rhs) -> bool1.0.0[src][−]

[+] Expand attributes#[must_use] fn gt(&self, other: &Rhs) -> bool1.0.0[src][−]

[+] Expand attributes#[must_use] fn ge(&self, other: &Rhs) -> bool1.0.0[src][−]

impl Send for StreamVolume[src]

impl StaticType for StreamVolume[+]

fn static_type() -> Type[−]

impl Sync for StreamVolume[src]

Auto Trait Implementations

impl RefUnwindSafe for StreamVolume

impl Unpin for StreamVolume

impl UnwindSafe for StreamVolume

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src][+]

fn type_id(&self) -> TypeId[src][−]

impl<T> Borrow<T> for T where T: ?Sized, [src][+]

fn borrow(&self) -> &T[src][−]

impl<T> BorrowMut<T> for T where T: ?Sized, [src][+]

fn borrow_mut(&mut self) -> &mut T[src][−]

impl<Super, Sub> CanDowncast<Sub> for Super where Sub: IsA<Super>, Super: IsA<Super>, [src]

impl<T> Cast for T where T: ObjectType, [src][+]

fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType, [src][−]

fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType, [src][−]

fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType, [src][−]

fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType, [src][−]

fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType, [src][−]

fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType, [src][−]

unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType, [src][−]

unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType, [src][−]

impl<T> From<T> for T[src][+]

fn from(t: T) -> T[src][−]

impl<O> GObjectExtManualGst for O where O: IsA<Object>, [src][+]

fn set_property_from_str(&self, name: &str, value: &str)[src]

impl<T, U> Into<U> for T where U: From<T>, [src][+]

fn into(self) -> U[src][−]

impl<T> ObjectExt for T where T: ObjectType, [src][+]

fn is<U>(&self) -> bool where U: StaticType, [src][−]

fn get_type(&self) -> Type[src]

fn get_object_class(&self) -> &ObjectClass[src]

fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue) -> Result<(), BoolError> where N: Into<&'a str>, [src]

fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>, [src]

fn block_signal(&self, handler_id: &SignalHandlerId)[src]

fn unblock_signal(&self, handler_id: &SignalHandlerId)[src]

fn stop_signal_emission(&self, signal_name: &str)[src]

fn disconnect(&self, handler_id: SignalHandlerId)[src]

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where F: 'static + Send + Sync + Fn(&T, &ParamSpec), [src]

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F) -> SignalHandlerId where F: Fn(&T, &ParamSpec), [src]

fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>, [src]

fn notify_by_pspec(&self, pspec: &ParamSpec)[src]

fn has_property<'a, N>( &self, property_name: N, type_: Option<Type>) -> Result<(), BoolError> where N: Into<&'a str>, [src]

fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>, [src]

`impl StreamVolume`[src][−]

`pub fn convert_volume( from: StreamVolumeFormat, to: StreamVolumeFormat, val: f64 ) -> f64`[src][−]

`from`

`to`

`val`

`impl Clone for StreamVolume`[+]

`fn clone(&self) -> StreamVolume`[−]

`fn clone_from(&mut self, source: &Self)`1.0.0[src][−]

`impl Debug for StreamVolume`[+]

`fn fmt(&self, f: &mut Formatter) -> Result`[−]

`impl Eq for StreamVolume`

`impl Hash for StreamVolume`[+]

`fn hash<H: Hasher>(&self, state: &mut H)`[−]

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

`impl Ord for StreamVolume`[+]

`fn cmp(&self, other: &StreamVolume) -> Ordering`[−]

`[+] Expand attributes #[must_use] fn max(self, other: Self) -> Self`1.21.0[src][−]

`[+] Expand attributes #[must_use] fn min(self, other: Self) -> Self`1.21.0[src][−]

`[+] Expand attributes #[must_use] fn clamp(self, min: Self, max: Self) -> Self`[src][−]

`impl<T: ObjectType> PartialEq<T> for StreamVolume`[+]

`fn eq(&self, other: &T) -> bool`[−]

`[+] Expand attributes #[must_use] fn ne(&self, other: &Rhs) -> bool`1.0.0[src][−]

`impl<T: ObjectType> PartialOrd<T> for StreamVolume`[+]

`fn partial_cmp(&self, other: &T) -> Option<Ordering>`[−]

`[+] Expand attributes #[must_use] fn lt(&self, other: &Rhs) -> bool`1.0.0[src][−]

`[+] Expand attributes #[must_use] fn le(&self, other: &Rhs) -> bool`1.0.0[src][−]

`[+] Expand attributes #[must_use] fn gt(&self, other: &Rhs) -> bool`1.0.0[src][−]

`[+] Expand attributes #[must_use] fn ge(&self, other: &Rhs) -> bool`1.0.0[src][−]

`impl Send for StreamVolume`[src]

`impl StaticType for StreamVolume`[+]

`fn static_type() -> Type`[−]

`impl Sync for StreamVolume`[src]

`impl RefUnwindSafe for StreamVolume`

`impl Unpin for StreamVolume`

`impl UnwindSafe for StreamVolume`

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

`fn type_id(&self) -> TypeId`[src][−]

`impl<T> Borrow<T> for T where T: ?Sized,` [src][+]

`fn borrow(&self) -> &T`[src][−]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src][+]

`fn borrow_mut(&mut self) -> &mut T`[src][−]

`impl<Super, Sub> CanDowncast<Sub> for Super where Sub: IsA<Super>, Super: IsA<Super>,` [src]

`impl<T> Cast for T where T: ObjectType,` [src][+]

`fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,` [src][−]

`fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,` [src][−]

`fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType,` [src][−]

`fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType,` [src][−]

`fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,` [src][−]

`fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,` [src][−]

`unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,` [src][−]

`unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,` [src][−]

`impl<T> From<T> for T`[src][+]

`fn from(t: T) -> T`[src][−]

`impl<O> GObjectExtManualGst for O where O: IsA<Object>,` [src][+]

`fn set_property_from_str(&self, name: &str, value: &str)`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src][+]

`fn into(self) -> U`[src][−]

`impl<T> ObjectExt for T where T: ObjectType,` [src][+]

`fn is<U>(&self) -> bool where U: StaticType,` [src][−]

`fn get_type(&self) -> Type`[src]

`fn get_object_class(&self) -> &ObjectClass`[src]

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,` [src]

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,` [src]

`fn block_signal(&self, handler_id: &SignalHandlerId)`[src]

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`[src]

`fn stop_signal_emission(&self, signal_name: &str)`[src]

`fn disconnect(&self, handler_id: SignalHandlerId)`[src]

`fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where F: 'static + Send + Sync + Fn(&T, &ParamSpec),` [src]

`unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId where F: Fn(&T, &ParamSpec),` [src]

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,` [src]

`fn notify_by_pspec(&self, pspec: &ParamSpec)`[src]

`fn has_property<'a, N>( &self, property_name: N, type_: Option<Type> ) -> Result<(), BoolError> where N: Into<&'a str>,` [src]

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,` [src]

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,` [src]

`fn list_properties(&self) -> Vec<ParamSpec>`[src]

`fn connect<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, N: Into<&'a str>,` [src]

`fn connect_local<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + 'static, N: Into<&'a str>,` [src]

`unsafe fn connect_unsafe<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value>, N: Into<&'a str>,` [src]

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,` [src]

`fn downgrade(&self) -> WeakRef<T>`[src]