gstreamer_controller/auto/

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

glib::wrapper! {
    /// [`LFOControlSource`][crate::LFOControlSource] is a [`gst::ControlSource`][crate::gst::ControlSource], that provides several periodic
    /// waveforms as control values.
    ///
    /// To use [`LFOControlSource`][crate::LFOControlSource] get a new instance by calling
    /// [`new()`][Self::new()], bind it to a `GParamSpec` and set the relevant
    /// properties.
    ///
    /// All functions are MT-safe.
    ///
    /// ## Properties
    ///
    ///
    /// #### `amplitude`
    ///  Specifies the amplitude for the waveform of this [`LFOControlSource`][crate::LFOControlSource].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `frequency`
    ///  Specifies the frequency that should be used for the waveform
    /// of this [`LFOControlSource`][crate::LFOControlSource]. It should be large enough
    /// so that the period is longer than one nanosecond.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `offset`
    ///  Specifies the value offset for the waveform of this [`LFOControlSource`][crate::LFOControlSource].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `timeshift`
    ///  Specifies the timeshift to the right that should be used for the waveform
    /// of this [`LFOControlSource`][crate::LFOControlSource] in nanoseconds.
    ///
    /// To get a n nanosecond shift to the left use
    /// "(GST_SECOND / frequency) - n".
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `waveform`
    ///  Specifies the waveform that should be used for this [`LFOControlSource`][crate::LFOControlSource].
    ///
    /// Readable | Writeable
    /// <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
    ///
    /// [`LFOControlSourceExt`][trait@crate::prelude::LFOControlSourceExt], [`trait@gst::prelude::ControlSourceExt`], [`trait@gst::prelude::ObjectExt`]
    #[doc(alias = "GstLFOControlSource")]
    pub struct LFOControlSource(Object<ffi::GstLFOControlSource, ffi::GstLFOControlSourceClass>) @extends gst::ControlSource, gst::Object;

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

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

    /// This returns a new, unbound [`LFOControlSource`][crate::LFOControlSource].
    ///
    /// # Returns
    ///
    /// a new, unbound [`LFOControlSource`][crate::LFOControlSource].
    #[doc(alias = "gst_lfo_control_source_new")]
    pub fn new() -> LFOControlSource {
        assert_initialized_main_thread!();
        unsafe {
            gst::ControlSource::from_glib_full(ffi::gst_lfo_control_source_new()).unsafe_cast()
        }
    }
}

impl Default for LFOControlSource {
    fn default() -> Self {
        Self::new()
    }
}

unsafe impl Send for LFOControlSource {}
unsafe impl Sync for LFOControlSource {}

/// Trait containing all [`struct@LFOControlSource`] methods.
///
/// # Implementors
///
/// [`LFOControlSource`][struct@crate::LFOControlSource]
pub trait LFOControlSourceExt: IsA<LFOControlSource> + 'static {
    /// Specifies the amplitude for the waveform of this [`LFOControlSource`][crate::LFOControlSource].
    fn amplitude(&self) -> f64 {
        ObjectExt::property(self.as_ref(), "amplitude")
    }

    /// Specifies the amplitude for the waveform of this [`LFOControlSource`][crate::LFOControlSource].
    fn set_amplitude(&self, amplitude: f64) {
        ObjectExt::set_property(self.as_ref(), "amplitude", amplitude)
    }

    /// Specifies the frequency that should be used for the waveform
    /// of this [`LFOControlSource`][crate::LFOControlSource]. It should be large enough
    /// so that the period is longer than one nanosecond.
    fn frequency(&self) -> f64 {
        ObjectExt::property(self.as_ref(), "frequency")
    }

    /// Specifies the frequency that should be used for the waveform
    /// of this [`LFOControlSource`][crate::LFOControlSource]. It should be large enough
    /// so that the period is longer than one nanosecond.
    fn set_frequency(&self, frequency: f64) {
        ObjectExt::set_property(self.as_ref(), "frequency", frequency)
    }

    /// Specifies the value offset for the waveform of this [`LFOControlSource`][crate::LFOControlSource].
    fn offset(&self) -> f64 {
        ObjectExt::property(self.as_ref(), "offset")
    }

    /// Specifies the value offset for the waveform of this [`LFOControlSource`][crate::LFOControlSource].
    fn set_offset(&self, offset: f64) {
        ObjectExt::set_property(self.as_ref(), "offset", offset)
    }

    /// Specifies the timeshift to the right that should be used for the waveform
    /// of this [`LFOControlSource`][crate::LFOControlSource] in nanoseconds.
    ///
    /// To get a n nanosecond shift to the left use
    /// "(GST_SECOND / frequency) - n".
    fn timeshift(&self) -> u64 {
        ObjectExt::property(self.as_ref(), "timeshift")
    }

    /// Specifies the timeshift to the right that should be used for the waveform
    /// of this [`LFOControlSource`][crate::LFOControlSource] in nanoseconds.
    ///
    /// To get a n nanosecond shift to the left use
    /// "(GST_SECOND / frequency) - n".
    fn set_timeshift(&self, timeshift: u64) {
        ObjectExt::set_property(self.as_ref(), "timeshift", timeshift)
    }

    /// Specifies the waveform that should be used for this [`LFOControlSource`][crate::LFOControlSource].
    fn waveform(&self) -> LFOWaveform {
        ObjectExt::property(self.as_ref(), "waveform")
    }

    /// Specifies the waveform that should be used for this [`LFOControlSource`][crate::LFOControlSource].
    fn set_waveform(&self, waveform: LFOWaveform) {
        ObjectExt::set_property(self.as_ref(), "waveform", waveform)
    }

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

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

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

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

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

impl<O: IsA<LFOControlSource>> LFOControlSourceExt for O {}