Struct gstreamer_net::NetClientClock

pub struct NetClientClock { /* private fields */ }

NetClientClock implements a custom gst::Clock that synchronizes its time to a remote time provider such as NetTimeProvider. NtpClock implements a gst::Clock that synchronizes its time to a remote NTPv4 server.

A new clock is created with new() or NtpClock::new(), which takes the address and port of the remote time provider along with a name and an initial time.

This clock will poll the time provider and will update its calibration parameters based on the local and remote observations.

The “round-trip” property limits the maximum round trip packets can take.

Various parameters of the clock can be configured with the parent gst::Clock “timeout”, “window-size” and “window-threshold” object properties.

A NetClientClock and NtpClock is typically set on a gst::Pipeline with [PipelineExtManual::use_clock()][crate::gst::prelude::PipelineExtManual::use_clock()].

If you set a gst::Bus on the clock via the “bus” object property, it will send GST_MESSAGE_ELEMENT messages with an attached gst::Structure containing statistics about clock accuracy and network traffic.

Properties

address

Readable | Writeable | Construct

base-time

Readable | Writeable | Construct Only

bus

Readable | Writeable

internal-clock

Readable

minimum-update-interval

Readable | Writeable

port

Readable | Writeable | Construct

qos-dscp

Readable | Writeable

round-trip-limit

Readable | Writeable

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]

GLib type: GObject with reference counted clone semantics.

Implementations

impl NetClientClock

pub fn new( name: Option<&str>, remote_address: &str, remote_port: i32, base_time: impl Into<Option<ClockTime>>, ) -> NetClientClock

Create a new NetClientClock that will report the time provided by the NetTimeProvider on remote_address and remote_port.

name

a name for the clock

remote_address

the address or hostname of the remote clock provider

remote_port

the port of the remote clock provider

base_time

initial time of the clock

Returns

a new gst::Clock that receives a time from the remote clock.

pub fn address(&self) -> Option<GString>

pub fn set_address(&self, address: Option<&str>)

pub fn base_time(&self) -> u64

pub fn bus(&self) -> Option<Bus>

pub fn set_bus<P: IsA<Bus>>(&self, bus: Option<&P>)

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

pub fn minimum_update_interval(&self) -> u64

pub fn set_minimum_update_interval(&self, minimum_update_interval: u64)

pub fn port(&self) -> i32

pub fn set_port(&self, port: i32)

pub fn qos_dscp(&self) -> i32

pub fn set_qos_dscp(&self, qos_dscp: i32)

pub fn round_trip_limit(&self) -> u64

pub fn set_round_trip_limit(&self, round_trip_limit: u64)

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

pub fn connect_bus_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_minimum_update_interval_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

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

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

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

Trait Implementations

impl Clone for NetClientClock

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for NetClientClock

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

Formats the value using the given formatter.

impl HasParamSpec for NetClientClock

type ParamSpec = ParamSpecObject

type SetValue = NetClientClock

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for NetClientClock

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

where H: Hasher,

Hashes the memory address of this object.

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 NetClientClock

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 NetClientClock

type Parent = Clock

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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 NetClientClock

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 NetClientClock

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for NetClientClock

impl IsA<Clock> for NetClientClock

impl IsA<NetClientClock> for NtpClock

impl IsA<Object> for NetClientClock

impl Send for NetClientClock

impl Sync for NetClientClock