gstreamer_audio/auto/

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

glib::wrapper! {
    /// This is the base class for audio sources. Subclasses need to implement the
    /// ::create_ringbuffer vmethod. This base class will then take care of
    /// reading samples from the ringbuffer, synchronisation and flushing.
    ///
    /// ## Properties
    ///
    ///
    /// #### `actual-buffer-time`
    ///  Actual configured size of audio buffer in microseconds.
    ///
    /// Readable
    ///
    ///
    /// #### `actual-latency-time`
    ///  Actual configured audio latency in microseconds.
    ///
    /// Readable
    ///
    ///
    /// #### `buffer-time`
    ///  Readable | Writeable
    ///
    ///
    /// #### `latency-time`
    ///  Readable | Writeable
    ///
    ///
    /// #### `provide-clock`
    ///  Readable | Writeable
    ///
    ///
    /// #### `slave-method`
    ///  Readable | Writeable
    /// <details><summary><h4>BaseSrc</h4></summary>
    ///
    ///
    /// #### `automatic-eos`
    ///  See [`BaseSrcExtManual::set_automatic_eos()`][crate::gst_base::prelude::BaseSrcExtManual::set_automatic_eos()]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `blocksize`
    ///  Readable | Writeable
    ///
    ///
    /// #### `do-timestamp`
    ///  Readable | Writeable
    ///
    ///
    /// #### `num-buffers`
    ///  Readable | Writeable
    ///
    ///
    /// #### `typefind`
    ///  Readable | Writeable
    /// </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 [`notify`][struct@crate::glib::Object#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
    ///
    /// [`AudioBaseSrcExt`][trait@crate::prelude::AudioBaseSrcExt], [`trait@gst_base::prelude::BaseSrcExt`], [`trait@gst::prelude::ElementExt`], [`trait@gst::prelude::GstObjectExt`], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstAudioBaseSrc")]
    pub struct AudioBaseSrc(Object<ffi::GstAudioBaseSrc, ffi::GstAudioBaseSrcClass>) @extends gst_base::BaseSrc, gst::Element, gst::Object;

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

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

unsafe impl Send for AudioBaseSrc {}
unsafe impl Sync for AudioBaseSrc {}

/// Trait containing all [`struct@AudioBaseSrc`] methods.
///
/// # Implementors
///
/// [`AudioBaseSrc`][struct@crate::AudioBaseSrc], [`AudioSrc`][struct@crate::AudioSrc]
pub trait AudioBaseSrcExt: IsA<AudioBaseSrc> + 'static {
    //#[doc(alias = "gst_audio_base_src_create_ringbuffer")]
    //fn create_ringbuffer(&self) -> /*Ignored*/Option<AudioRingBuffer> {
    //    unsafe { TODO: call ffi:gst_audio_base_src_create_ringbuffer() }
    //}

    /// Queries whether `self` will provide a clock or not. See also
    /// gst_audio_base_src_set_provide_clock.
    ///
    /// # Returns
    ///
    /// [`true`] if `self` will provide a clock.
    #[doc(alias = "gst_audio_base_src_get_provide_clock")]
    #[doc(alias = "get_provide_clock")]
    #[doc(alias = "provide-clock")]
    fn is_provide_clock(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_audio_base_src_get_provide_clock(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    //#[doc(alias = "gst_audio_base_src_get_slave_method")]
    //#[doc(alias = "get_slave_method")]
    //#[doc(alias = "slave-method")]
    //fn slave_method(&self) -> /*Ignored*/AudioBaseSrcSlaveMethod {
    //    unsafe { TODO: call ffi:gst_audio_base_src_get_slave_method() }
    //}

    /// Controls whether `self` will provide a clock or not. If `provide` is [`true`],
    /// [`ElementExtManual::provide_clock()`][crate::gst::prelude::ElementExtManual::provide_clock()] will return a clock that reflects the datarate
    /// of `self`. If `provide` is [`false`], [`ElementExtManual::provide_clock()`][crate::gst::prelude::ElementExtManual::provide_clock()] will return NULL.
    /// ## `provide`
    /// new state
    #[doc(alias = "gst_audio_base_src_set_provide_clock")]
    #[doc(alias = "provide-clock")]
    fn set_provide_clock(&self, provide: bool) {
        unsafe {
            ffi::gst_audio_base_src_set_provide_clock(
                self.as_ref().to_glib_none().0,
                provide.into_glib(),
            );
        }
    }

    //#[doc(alias = "gst_audio_base_src_set_slave_method")]
    //#[doc(alias = "slave-method")]
    //fn set_slave_method(&self, method: /*Ignored*/AudioBaseSrcSlaveMethod) {
    //    unsafe { TODO: call ffi:gst_audio_base_src_set_slave_method() }
    //}

    /// Actual configured size of audio buffer in microseconds.
    #[doc(alias = "actual-buffer-time")]
    fn actual_buffer_time(&self) -> i64 {
        ObjectExt::property(self.as_ref(), "actual-buffer-time")
    }

    /// Actual configured audio latency in microseconds.
    #[doc(alias = "actual-latency-time")]
    fn actual_latency_time(&self) -> i64 {
        ObjectExt::property(self.as_ref(), "actual-latency-time")
    }

    #[doc(alias = "buffer-time")]
    fn buffer_time(&self) -> i64 {
        ObjectExt::property(self.as_ref(), "buffer-time")
    }

    #[doc(alias = "buffer-time")]
    fn set_buffer_time(&self, buffer_time: i64) {
        ObjectExt::set_property(self.as_ref(), "buffer-time", buffer_time)
    }

    #[doc(alias = "latency-time")]
    fn latency_time(&self) -> i64 {
        ObjectExt::property(self.as_ref(), "latency-time")
    }

    #[doc(alias = "latency-time")]
    fn set_latency_time(&self, latency_time: i64) {
        ObjectExt::set_property(self.as_ref(), "latency-time", latency_time)
    }

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

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

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

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

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

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

impl<O: IsA<AudioBaseSrc>> AudioBaseSrcExt for O {}