gstreamer_audio/auto/

stream_volume.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{ffi, StreamVolumeFormat};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// 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`][crate::glib::Object] property can be used or the helper functions [`StreamVolumeExt::set_volume()`][crate::prelude::StreamVolumeExt::set_volume()]
    /// and [`StreamVolumeExt::volume()`][crate::prelude::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()`][Self::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`][crate::glib::Object] property or
    /// [`StreamVolumeExt::set_mute()`][crate::prelude::StreamVolumeExt::set_mute()] and [`StreamVolumeExt::is_muted()`][crate::prelude::StreamVolumeExt::is_muted()].
    ///
    /// Elements that provide some kind of stream volume should implement the "volume" and
    /// "mute" [`glib::Object`][crate::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`][trait@crate::prelude::StreamVolumeExt]
    #[doc(alias = "GstStreamVolume")]
    pub struct StreamVolume(Interface<ffi::GstStreamVolume, ffi::GstStreamVolumeInterface>);

    match fn {
        type_ => || ffi::gst_stream_volume_get_type(),
    }
}

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

    /// ## `from`
    /// [`StreamVolumeFormat`][crate::StreamVolumeFormat] to convert from
    /// ## `to`
    /// [`StreamVolumeFormat`][crate::StreamVolumeFormat] to convert to
    /// ## `val`
    /// Volume in `from` format that should be converted
    ///
    /// # Returns
    ///
    /// the converted volume
    #[doc(alias = "gst_stream_volume_convert_volume")]
    pub fn convert_volume(from: StreamVolumeFormat, to: StreamVolumeFormat, val: f64) -> f64 {
        assert_initialized_main_thread!();
        unsafe { ffi::gst_stream_volume_convert_volume(from.into_glib(), to.into_glib(), val) }
    }
}

unsafe impl Send for StreamVolume {}
unsafe impl Sync for StreamVolume {}

/// Trait containing all [`struct@StreamVolume`] methods.
///
/// # Implementors
///
/// [`StreamVolume`][struct@crate::StreamVolume]
pub trait StreamVolumeExt: IsA<StreamVolume> + 'static {
    ///
    /// # Returns
    ///
    /// Returns [`true`] if the stream is muted
    #[doc(alias = "gst_stream_volume_get_mute")]
    #[doc(alias = "get_mute")]
    #[doc(alias = "mute")]
    fn is_muted(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_stream_volume_get_mute(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// ## `format`
    /// [`StreamVolumeFormat`][crate::StreamVolumeFormat] which should be returned
    ///
    /// # Returns
    ///
    /// The current stream volume as linear factor
    #[doc(alias = "gst_stream_volume_get_volume")]
    #[doc(alias = "get_volume")]
    fn volume(&self, format: StreamVolumeFormat) -> f64 {
        unsafe {
            ffi::gst_stream_volume_get_volume(self.as_ref().to_glib_none().0, format.into_glib())
        }
    }

    /// ## `mute`
    /// Mute state that should be set
    #[doc(alias = "gst_stream_volume_set_mute")]
    #[doc(alias = "mute")]
    fn set_mute(&self, mute: bool) {
        unsafe {
            ffi::gst_stream_volume_set_mute(self.as_ref().to_glib_none().0, mute.into_glib());
        }
    }

    /// ## `format`
    /// [`StreamVolumeFormat`][crate::StreamVolumeFormat] of `val`
    /// ## `val`
    /// Linear volume factor that should be set
    #[doc(alias = "gst_stream_volume_set_volume")]
    #[doc(alias = "volume")]
    fn set_volume(&self, format: StreamVolumeFormat, val: f64) {
        unsafe {
            ffi::gst_stream_volume_set_volume(
                self.as_ref().to_glib_none().0,
                format.into_glib(),
                val,
            );
        }
    }

    #[doc(alias = "mute")]
    fn connect_mute_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_mute_trampoline<
            P: IsA<StreamVolume>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstStreamVolume,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(StreamVolume::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::mute".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_mute_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "volume")]
    fn connect_volume_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_volume_trampoline<
            P: IsA<StreamVolume>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstStreamVolume,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(StreamVolume::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::volume".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_volume_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<StreamVolume>> StreamVolumeExt for O {}