Gjsify LogoGjsify Logo

Index

Variables

NET_TIME_PACKET_SIZE: number

The size of the packets sent between network clocks.

PTP_CLOCK_ID_NONE: number

PTP clock identification that can be passed to gst_ptp_init() to automatically select one based on the MAC address of interfaces

PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED: string
PTP_STATISTICS_NEW_DOMAIN_FOUND: string
PTP_STATISTICS_PATH_DELAY_MEASURED: string
PTP_STATISTICS_TIME_UPDATED: string

Functions

  • net_address_meta_api_get_type(): GType
  • net_control_message_meta_api_get_type(): GType
  • net_utils_set_socket_tos(socket: Gio.Socket, qos_dscp: number): boolean
  • Configures IP_TOS value of socket, i.e. sets QoS DSCP.

    Parameters

    • socket: Gio.Socket

      Socket to configure

    • qos_dscp: number

      QoS DSCP value

    Returns boolean

  • ptp_deinit(): void
  • 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.

    Returns void

  • ptp_init(clock_id: number, interfaces: string[]): boolean
  • 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 %GST_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 gst_ptp_clock_new() with default parameters if it wasn't called before.

    Parameters

    • clock_id: number

      PTP clock id of this process' clock or %GST_PTP_CLOCK_ID_NONE

    • interfaces: string[]

      network interfaces to run the clock on

    Returns boolean

  • ptp_is_initialized(): boolean
  • ptp_is_supported(): boolean
  • Check if PTP clocks are generally supported on this system, and if previous initializations did not fail.

    Returns boolean

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

    Parameters

    Returns number

  • ptp_statistics_callback_remove(id: number): void
  • Removes a PTP statistics callback that was previously added with gst_ptp_statistics_callback_add().

    Parameters

    • id: number

      Callback id to remove

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method