Struct gstreamer_net::NetClientClock

[+] Show declaration

pub struct NetClientClock(_, _);

[−] Expand description

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 NetClientClock::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 gst::Pipeline::use_clock.

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

Implements

gst::ClockExt, gst::ObjectExt, glib::object::ObjectExt

Methods

impl NetClientClock[−]

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

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

pub fn get_property_base_time(&self) -> u64

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

pub fn set_property_bus<P: IsA<Bus> + SetValueOptional>(&self, bus: Option<&P>)

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

pub fn get_property_minimum_update_interval(&self) -> u64

pub fn set_property_minimum_update_interval(&self, minimum_update_interval: u64)

pub fn get_property_port(&self) -> i32

pub fn set_property_port(&self, port: i32)

pub fn get_property_qos_dscp(&self) -> i32

pub fn set_property_qos_dscp(&self, qos_dscp: i32)

pub fn get_property_round_trip_limit(&self) -> u64

pub fn set_property_round_trip_limit(&self, round_trip_limit: u64)

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

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

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

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

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

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

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

impl NetClientClock[−]

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

Create a new GstNetClientInternalClock 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.

Trait Implementations

impl Clone for NetClientClock[+]

[+] Show hidden undocumented items

fn clone(&self) -> NetClientClock[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for NetClientClock[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for NetClientClock

impl Hash for NetClientClock[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl IsA<Clock> for NetClientClock

impl IsA<NetClientClock> for NtpClock

impl IsA<Object> for NetClientClock

impl Ord for NetClientClock[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &NetClientClock) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use] fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for NetClientClock[+]

[+] Show hidden undocumented items

fn eq(&self, other: &T) -> bool[−]

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

[+] Expand attributes

#[must_use] fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for NetClientClock[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &T) -> Option<Ordering>[−]

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

[+] Expand attributes

#[must_use] fn lt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use] fn le(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use] fn gt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use] 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 Send for NetClientClock

impl StaticType for NetClientClock[+]

[+] Show hidden undocumented items

fn static_type() -> Type[−]

Returns the type identifier of Self.

impl Sync for NetClientClock