gstreamer_controller/auto/

direct_control_binding.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;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A value mapping object that attaches control sources to gobject properties. It
    /// will map the control values directly to the target property range. If a
    /// non-absolute direct control binding is used, the value range [0.0 ... 1.0]
    /// is mapped to full target property range, and all values outside the range
    /// will be clipped. An absolute control binding will not do any value
    /// transformations.
    ///
    /// ## Properties
    ///
    ///
    /// #### `absolute`
    ///  Readable | Writeable | Construct Only
    ///
    ///
    /// #### `control-source`
    ///  Readable | Writeable | Construct
    /// <details><summary><h4>ControlBinding</h4></summary>
    ///
    ///
    /// #### `name`
    ///  Readable | Writeable | Construct Only
    ///
    ///
    /// #### `object`
    ///  Readable | Writeable | Construct Only
    /// </details>
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `name`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `parent`
    ///  The parent of the object. Please note, that when changing the 'parent'
    /// property, we don't emit `GObject::notify` and [`deep-notify`][struct@crate::gst::Object#deep-notify]
    /// signals due to locking issues. In some cases one can use
    /// `GstBin::element-added` or `GstBin::element-removed` signals on the parent to
    /// achieve a similar effect.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`DirectControlBindingExt`][trait@crate::prelude::DirectControlBindingExt], [`trait@gst::prelude::ControlBindingExt`], [`trait@gst::prelude::ObjectExt`]
    #[doc(alias = "GstDirectControlBinding")]
    pub struct DirectControlBinding(Object<ffi::GstDirectControlBinding, ffi::GstDirectControlBindingClass>) @extends gst::ControlBinding, gst::Object;

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

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

    /// Create a new control-binding that attaches the [`gst::ControlSource`][crate::gst::ControlSource] to the
    /// `GObject` property. It will map the control source range [0.0 ... 1.0] to
    /// the full target property range, and clip all values outside this range.
    /// ## `object`
    /// the object of the property
    /// ## `property_name`
    /// the property-name to attach the control source
    /// ## `cs`
    /// the control source
    ///
    /// # Returns
    ///
    /// the new [`DirectControlBinding`][crate::DirectControlBinding]
    #[doc(alias = "gst_direct_control_binding_new")]
    pub fn new(
        object: &impl IsA<gst::Object>,
        property_name: &str,
        cs: &impl IsA<gst::ControlSource>,
    ) -> DirectControlBinding {
        assert_initialized_main_thread!();
        unsafe {
            gst::ControlBinding::from_glib_none(ffi::gst_direct_control_binding_new(
                object.as_ref().to_glib_none().0,
                property_name.to_glib_none().0,
                cs.as_ref().to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

    /// Create a new control-binding that attaches the [`gst::ControlSource`][crate::gst::ControlSource] to the
    /// `GObject` property. It will directly map the control source values to the
    /// target property range without any transformations.
    /// ## `object`
    /// the object of the property
    /// ## `property_name`
    /// the property-name to attach the control source
    /// ## `cs`
    /// the control source
    ///
    /// # Returns
    ///
    /// the new [`DirectControlBinding`][crate::DirectControlBinding]
    #[doc(alias = "gst_direct_control_binding_new_absolute")]
    pub fn new_absolute(
        object: &impl IsA<gst::Object>,
        property_name: &str,
        cs: &impl IsA<gst::ControlSource>,
    ) -> DirectControlBinding {
        assert_initialized_main_thread!();
        unsafe {
            gst::ControlBinding::from_glib_none(ffi::gst_direct_control_binding_new_absolute(
                object.as_ref().to_glib_none().0,
                property_name.to_glib_none().0,
                cs.as_ref().to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }
}

unsafe impl Send for DirectControlBinding {}
unsafe impl Sync for DirectControlBinding {}

/// Trait containing all [`struct@DirectControlBinding`] methods.
///
/// # Implementors
///
/// [`DirectControlBinding`][struct@crate::DirectControlBinding]
pub trait DirectControlBindingExt: IsA<DirectControlBinding> + 'static {
    fn is_absolute(&self) -> bool {
        ObjectExt::property(self.as_ref(), "absolute")
    }

    #[doc(alias = "control-source")]
    fn control_source(&self) -> Option<gst::ControlSource> {
        ObjectExt::property(self.as_ref(), "control-source")
    }

    #[doc(alias = "control-source")]
    fn set_control_source<P: IsA<gst::ControlSource>>(&self, control_source: Option<&P>) {
        ObjectExt::set_property(self.as_ref(), "control-source", control_source)
    }

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

impl<O: IsA<DirectControlBinding>> DirectControlBindingExt for O {}