gstreamer_net/auto/

ptp_clock.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! {
    ///  1024 and thus requires special
    /// privileges. Once this helper process is started, the main process will
    /// synchronize to all PTP domains that are detected on the selected
    /// interfaces.
    ///
    /// [`new()`][Self::new()] then allows to create a GstClock that provides the PTP
    /// time from a master clock inside a specific PTP domain. This clock will only
    /// return valid timestamps once the timestamps in the PTP domain are known. To
    /// check this, you can use [`ClockExtManual::wait_for_sync()`][crate::gst::prelude::ClockExtManual::wait_for_sync()], the GstClock::synced
    /// signal and [`ClockExtManual::is_synced()`][crate::gst::prelude::ClockExtManual::is_synced()].
    ///
    /// To gather statistics about the PTP clock synchronization,
    /// `gst_ptp_statistics_callback_add()` can be used. This gives the application
    /// the possibility to collect all kinds of statistics from the clock
    /// synchronization.
    ///
    /// ## Properties
    ///
    ///
    /// #### `domain`
    ///  Readable | Writable | Construct Only
    ///
    ///
    /// #### `grandmaster-clock-id`
    ///  Readable
    ///
    ///
    /// #### `internal-clock`
    ///  Readable
    ///
    ///
    /// #### `master-clock-id`
    ///  Readable
    /// <details><summary><h4>SystemClock</h4></summary>
    ///
    ///
    /// #### `clock-type`
    ///  Readable | Writable
    /// </details>
    /// <details><summary><h4>Clock</h4></summary>
    ///
    ///
    /// #### `timeout`
    ///  Readable | Writable
    ///
    ///
    /// #### `window-size`
    ///  Readable | Writable
    ///
    ///
    /// #### `window-threshold`
    ///  Readable | Writable
    /// </details>
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `name`
    ///  Readable | Writable | 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 | Writable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`trait@gst::prelude::ClockExt`], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstPtpClock")]
    pub struct PtpClock(Object<ffi::GstPtpClock, ffi::GstPtpClockClass>) @extends gst::Clock, gst::Object;

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

impl PtpClock {
    /// Creates a new PTP clock instance that exports the PTP time of the master
    /// clock in `domain`. This clock can be slaved to other clocks as needed.
    ///
    /// If `gst_ptp_init()` was not called before, this will call `gst_ptp_init()` with
    /// default parameters.
    ///
    /// This clock only returns valid timestamps after it received the first
    /// times from the PTP master clock on the network. Once this happens the
    /// GstPtpClock::internal-clock property will become non-NULL. You can
    /// check this with [`ClockExtManual::wait_for_sync()`][crate::gst::prelude::ClockExtManual::wait_for_sync()], the GstClock::synced signal and
    /// [`ClockExtManual::is_synced()`][crate::gst::prelude::ClockExtManual::is_synced()].
    /// ## `name`
    /// Name of the clock
    /// ## `domain`
    /// PTP domain
    ///
    /// # Returns
    ///
    /// A new [`gst::Clock`][crate::gst::Clock]
    #[doc(alias = "gst_ptp_clock_new")]
    pub fn new(name: Option<&str>, domain: u32) -> Result<PtpClock, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<gst::Clock>::from_glib_full(ffi::gst_ptp_clock_new(
                name.to_glib_none().0,
                domain,
            ))
            .map(|o| o.unsafe_cast())
            .ok_or_else(|| glib::bool_error!("Can't create gst::PtpClock"))
        }
    }

    pub fn domain(&self) -> u32 {
        ObjectExt::property(self, "domain")
    }

    #[doc(alias = "grandmaster-clock-id")]
    pub fn grandmaster_clock_id(&self) -> u64 {
        ObjectExt::property(self, "grandmaster-clock-id")
    }

    #[doc(alias = "internal-clock")]
    pub fn internal_clock(&self) -> Option<gst::Clock> {
        ObjectExt::property(self, "internal-clock")
    }

    #[doc(alias = "master-clock-id")]
    pub fn master_clock_id(&self) -> u64 {
        ObjectExt::property(self, "master-clock-id")
    }

    #[doc(alias = "grandmaster-clock-id")]
    pub fn connect_grandmaster_clock_id_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_grandmaster_clock_id_trampoline<
            F: Fn(&PtpClock) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstPtpClock,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::grandmaster-clock-id".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_grandmaster_clock_id_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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

    #[doc(alias = "master-clock-id")]
    pub fn connect_master_clock_id_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_master_clock_id_trampoline<
            F: Fn(&PtpClock) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstPtpClock,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::master-clock-id".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_master_clock_id_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

unsafe impl Send for PtpClock {}
unsafe impl Sync for PtpClock {}