Struct gstreamer_net::PtpClock

pub struct PtpClock { /* private fields */ }

GstPtpClock implements a PTP (IEEE1588:2008) ordinary clock in slave-only mode, that allows a GStreamer pipeline to synchronize to a PTP network clock in some specific domain.

The PTP subsystem can be initialized with gst_ptp_init(), which then starts a helper process to do the actual communication via the PTP ports. This is required as PTP listens on ports < 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() 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 | Writeable | Construct Only

grandmaster-clock-id

Readable

internal-clock

Readable

master-clock-id

Readable

SystemClock

clock-type

Readable | Writeable

Clock

timeout

Readable | Writeable

window-size

Readable | Writeable

window-threshold

Readable | Writeable

Object

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 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

Implements

gst::prelude::ClockExt, gst::prelude::ObjectExt, [trait@glib::ObjectExt]

Implementations

impl PtpClock

pub fn new(name: &str, domain: u32) -> 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

pub fn domain(&self) -> u32

pub fn grandmaster_clock_id(&self) -> u64

pub fn internal_clock(&self) -> Option<Clock>

pub fn master_clock_id(&self) -> u64

pub fn connect_grandmaster_clock_id_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_internal_clock_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_master_clock_id_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

impl PtpClock

pub fn init(clock_id: Option<u64>, interfaces: &[&str]) -> Result<(), BoolError>

Initialize GStreamer PTP clock support

This is automatically called once the first PTP clock instance is created.

pub fn init_full(s: &StructureRef) -> Result<(), BoolError>

Initialize GStreamer PTP clock support

This is automatically called once the first PTP clock instance is created.

pub fn deinit()

Deinitialize GStreamer PTP clock support

Any PTP clocks that are still running will not receive any updates anymore.

pub fn is_initialized() -> bool

Check if the GStreamer PTP clock support is initialized

pub fn is_supported() -> bool

Check if GStreamer PTP clocks are supported

pub fn add_statistics_callback<F: Fn(u8, &StructureRef) -> ControlFlow + 'static + Send + Sync>( func: F ) -> PtpStatisticsCallback

Add a PTP clock statistics callback

Trait Implementations

impl Clone for PtpClock

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PtpClock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for PtpClock

type ParamSpec = ParamSpecObject

type SetValue = PtpClock

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PtpClock>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PtpClock

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PtpClock

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PtpClock

type Parent = Clock

impl<OT: ObjectType> PartialEq<OT> for PtpClock

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PtpClock

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PtpClock

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PtpClock

impl IsA<Clock> for PtpClock

impl IsA<Object> for PtpClock

impl Send for PtpClock

impl Sync for PtpClock