GstPtpClock

GstNet.PtpClock

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Clock
                ╰──Gst.SystemClock
                    ╰──GstNet.PtpClock

GstNet.PtpClock.prototype.new

function GstNet.PtpClock.prototype.new(name: String, domain: Number): {
    // javascript wrapper for 'gst_ptp_clock_new'
}

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 GstNet.prototype.ptp_init was not called before, this will call GstNet.prototype.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 Gst.Clock.prototype.wait_for_sync, the GstClock::synced signal and Gst.Clock.prototype.is_synced.

Since : 1.6

domain

“domain” Number

Flags : Read / Write / Construct Only

grandmaster-clock-id

“grandmaster-clock-id” Number

Flags : Read

internal-clock

“internal-clock” Gst.Clock

Flags : Read

master-clock-id

“master-clock-id” Number

Flags : Read

GstNet.prototype.ptp_deinit

function GstNet.prototype.ptp_deinit(): {
    // javascript wrapper for 'gst_ptp_deinit'
}

Deinitialize the GStreamer PTP subsystem and stop the PTP clock. If there are any remaining GstPtpClock instances, they won't be further synchronized to the PTP network clock.

Since : 1.6

GstNet.prototype.ptp_init

function GstNet.prototype.ptp_init(clock_id: Number, interfaces: [ String ]): {
    // javascript wrapper for 'gst_ptp_init'
}

Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in slave-only mode for all domains on the given interfaces with the given clock_id.

If clock_id is GstNet.PTP_CLOCK_ID_NONE, a clock id is automatically generated from the MAC address of the first network interface.

This function is automatically called by GstNet.PtpClock.prototype.new with default parameters if it wasn't called before.

Since : 1.6

GstNet.prototype.ptp_init_full

function GstNet.prototype.ptp_init_full(config: Gst.Structure): {
    // javascript wrapper for 'gst_ptp_init_full'
}

Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in slave-only mode according to the config.

config is a Gst.Structure with the following optional fields:

• Number clock-id: The clock ID to use for the local clock. If the clock-id is not provided or GstNet.PTP_CLOCK_ID_NONE is provided, a clock id is automatically generated from the MAC address of the first network interface.
• GStrv (not introspectable) interfaces: The interface names to listen on for PTP packets. If none are provided then all compatible interfaces will be used.
• Number ttl: The TTL to use for multicast packets sent out by GStreamer. This defaults to 1, i.e. packets will not leave the local network.

This function is automatically called by GstNet.PtpClock.prototype.new with default parameters if it wasn't called before.

Since : 1.24

GstNet.prototype.ptp_is_initialized

function GstNet.prototype.ptp_is_initialized(): {
    // javascript wrapper for 'gst_ptp_is_initialized'
}

Check if the GStreamer PTP clock subsystem is initialized.

Since : 1.6

GstNet.prototype.ptp_is_supported

function GstNet.prototype.ptp_is_supported(): {
    // javascript wrapper for 'gst_ptp_is_supported'
}

Check if PTP clocks are generally supported on this system, and if previous initializations did not fail.

Since : 1.6

GstNet.prototype.ptp_statistics_callback_add

function GstNet.prototype.ptp_statistics_callback_add(callback: GstNet.PtpStatisticsCallback, user_data: Object): {
    // javascript wrapper for 'gst_ptp_statistics_callback_add'
}

Installs a new statistics callback for gathering PTP statistics. See GstPtpStatisticsCallback for a list of statistics that are provided.

Since : 1.6

GstNet.prototype.ptp_statistics_callback_remove

function GstNet.prototype.ptp_statistics_callback_remove(id: Number): {
    // javascript wrapper for 'gst_ptp_statistics_callback_remove'
}

Removes a PTP statistics callback that was previously added with GstNet.prototype.ptp_statistics_callback_add.

Since : 1.6

GstNet.PTP_CLOCK_ID_NONE

PTP clock identification that can be passed to GstNet.prototype.ptp_init to automatically select one based on the MAC address of interfaces

GstNet.PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED

GstNet.PTP_STATISTICS_NEW_DOMAIN_FOUND

GstNet.PTP_STATISTICS_PATH_DELAY_MEASURED

GstNet.PTP_STATISTICS_TIME_UPDATED

GstNet.PtpStatisticsCallback

function GstNet.PtpStatisticsCallback(domain: Number, stats: Gst.Structure, user_data: Object): {
    // javascript wrapper for 'GstPtpStatisticsCallback'
}

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