gstnet

type NetAddressMeta ¶

type NetAddressMeta struct {
	// contains filtered or unexported fields
}

NetAddressMeta can be used to store a network address (a Address) in a Buffer so that it network elements can track the to and from address of the buffer.

An instance of this type is always passed by reference.

func BufferAddNetAddressMeta(buffer *gst.Buffer, addr gio.SocketAddresser) *NetAddressMeta

func BufferGetNetAddressMeta(buffer *gst.Buffer) *NetAddressMeta

func (n *NetAddressMeta) Addr() gio.SocketAddresser

func (n *NetAddressMeta) Meta() *gst.Meta

type NetClientClock ¶

type NetClientClock struct {
	gst.SystemClock
	// contains filtered or unexported fields
}

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

A new clock is created with gst_net_client_clock_new() or gst_ntp_clock_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 Clock "timeout", "window-size" and "window-threshold" object properties.

A NetClientClock and NtpClock is typically set on a Pipeline with gst_pipeline_use_clock().

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

func NewNetClientClock(name, remoteAddress string, remotePort int, baseTime gst.ClockTime) *NetClientClock

type NetClientClockClass ¶

type NetClientClockClass struct {
	// contains filtered or unexported fields
}

NetClientClockClass: instance of this type is always passed by reference.

func (n *NetClientClockClass) ParentClass() *gst.SystemClockClass

type NetClientClockOverrides ¶

type NetClientClockOverrides struct {
}

NetClientClockOverrides contains methods that are overridable.

type NetControlMessageMeta ¶

type NetControlMessageMeta struct {
	// contains filtered or unexported fields
}

NetControlMessageMeta can be used to store control messages (ancillary data) which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See CredentialsMessage) and Unix file descriptions (See FDMessage).

An instance of this type is always passed by reference.

func BufferAddNetControlMessageMeta(buffer *gst.Buffer, message gio.SocketControlMessager) *NetControlMessageMeta

func (n *NetControlMessageMeta) Message() gio.SocketControlMessager

func (n *NetControlMessageMeta) Meta() *gst.Meta

type NetTimePacket ¶

type NetTimePacket struct {
	// contains filtered or unexported fields
}

NetTimePacket various functions for receiving, sending an serializing NetTimePacket structures.

An instance of this type is always passed by reference.

func NetTimePacketReceive(socket *gio.Socket) (gio.SocketAddresser, *NetTimePacket, error)

func (packet *NetTimePacket) Copy() *NetTimePacket

func (n *NetTimePacket) LocalTime() gst.ClockTime

func (n *NetTimePacket) RemoteTime() gst.ClockTime

func (packet *NetTimePacket) Send(socket *gio.Socket, destAddress gio.SocketAddresser) error

func (packet *NetTimePacket) Serialize() *byte

type NetTimeProvider ¶

type NetTimeProvider struct {
	gst.GstObject

	gio.Initable
	// contains filtered or unexported fields
}

NetTimeProvider: this object exposes the time of a Clock on the network.

A NetTimeProvider is created with gst_net_time_provider_new() which takes a Clock, an address and a port number as arguments.

After creating the object, a client clock such as NetClientClock can query the exposed clock over the network for its values.

The NetTimeProvider typically wraps the clock used by a Pipeline.

func NewNetTimeProvider(clock gst.Clocker, address string, port int) *NetTimeProvider

type NetTimeProviderClass ¶

type NetTimeProviderClass struct {
	// contains filtered or unexported fields
}

NetTimeProviderClass: instance of this type is always passed by reference.

func (n *NetTimeProviderClass) GstReserved() [4]unsafe.Pointer

func (n *NetTimeProviderClass) ParentClass() *gst.ObjectClass

type NetTimeProviderOverrides ¶

type NetTimeProviderOverrides struct {
}

NetTimeProviderOverrides contains methods that are overridable.

type NtpClock ¶

type NtpClock struct {
	NetClientClock
	// contains filtered or unexported fields
}

func NewNtpClock(name, remoteAddress string, remotePort int, baseTime gst.ClockTime) *NtpClock

type NtpClockClass ¶

type NtpClockClass struct {
	// contains filtered or unexported fields
}

NtpClockClass: instance of this type is always passed by reference.

func (n *NtpClockClass) ParentClass() *gst.SystemClockClass

type NtpClockOverrides ¶

type NtpClockOverrides struct {
}

NtpClockOverrides contains methods that are overridable.

type PtpClock ¶

type PtpClock struct {
	gst.SystemClock
	// contains filtered or unexported fields
}

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

gst_ptp_clock_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 gst_clock_wait_for_sync(), the GstClock::synced signal and gst_clock_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.

func NewPtpClock(name string, domain uint) *PtpClock

type PtpClockClass ¶

type PtpClockClass struct {
	// contains filtered or unexported fields
}

PtpClockClass: opaque PtpClockClass structure.

An instance of this type is always passed by reference.

func (p *PtpClockClass) ParentClass() *gst.SystemClockClass

type PtpClockOverrides ¶

type PtpClockOverrides struct {
}

PtpClockOverrides contains methods that are overridable.

type PtpStatisticsCallback ¶

type PtpStatisticsCallback func(domain byte, stats *gst.Structure) (ok bool)

PtpStatisticsCallback statistics can be the following structures:

GST_PTP_STATISTICS_NEW_DOMAIN_FOUND: "domain" G_TYPE_UINT The domain identifier of the domain "clock" GST_TYPE_CLOCK The internal clock that is slaved to the PTP domain

GST_PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED: "domain" G_TYPE_UINT The domain identifier of the domain "master-clock-id" G_TYPE_UINT64 PTP clock identifier of the selected master clock "master-clock-port" G_TYPE_UINT PTP port number of the selected master clock "grandmaster-clock-id" G_TYPE_UINT64 PTP clock identifier of the grandmaster clock

GST_PTP_STATISTICS_PATH_DELAY_MEASURED: "domain" G_TYPE_UINT The domain identifier of the domain "mean-path-delay-avg" GST_TYPE_CLOCK_TIME Average mean path delay "mean-path-delay" GST_TYPE_CLOCK_TIME Latest mean path delay "delay-request-delay" GST_TYPE_CLOCK_TIME Delay of DELAY_REQ / DELAY_RESP messages

GST_PTP_STATISTICS_TIME_UPDATED: "domain" G_TYPE_UINT The domain identifier of the domain "mean-path-delay-avg" GST_TYPE_CLOCK_TIME Average mean path delay "local-time" GST_TYPE_CLOCK_TIME Local time that corresponds to ptp-time "ptp-time" GST_TYPE_CLOCK_TIME Newly measured PTP time at local-time "estimated-ptp-time" GST_TYPE_CLOCK_TIME Estimated PTP time based on previous measurements "discontinuity" G_TYPE_INT64 Difference between estimated and measured PTP time "synced" G_TYPE_BOOLEAN Currently synced to the remote clock "r-squared" G_TYPE_DOUBLE R² of clock estimation regression "internal-time" GST_TYPE_CLOCK_TIME Internal time clock parameter "external-time" GST_TYPE_CLOCK_TIME External time clock parameter "rate-num" G_TYPE_UINT64 Internal/external rate numerator "rate-den" G_TYPE_UINT64 Internal/external rate denominator "rate" G_TYPE_DOUBLE Internal/external rate

If FALSE is returned, the callback is removed and never called again.