GStreamer WebRTC Wrapper - Architecture - GstWebRTCWrapperBin BaseSignaler

From RidgeRun Developer Wiki




Previous: Architecture/GstWebRTCWrapperBin_Modules Index Next: Architecture/GstWebRTCWrapperBin_PubnubSignaler




BaseSignaler

GstBaseSignalerClass

This module handles the signaling mechanism to negotiate.

Methods

  • connect(GstBaseSignaler * self): Connect to signaling server.
  • disconnect(GstBaseSignaler * self): Disconnect from signaling server.
  • is_connect(GstBaseSignaler * self): Check whether there is a connection to signaling server.
  • send_local_description(GstBaseSignaler * self, gchar * description, GstWebRTCSDPType type): Send the local description through signaling.
  • send_candidate(GstBaseSignaler * self, const gchar * mid, gint sdpmlineindex, gchar * candidate): Send the candidate through signaling.

Signals

  • connected: Emitted when a peer is connected to the same session.
  • disconnected: Emitted when the peer is disconnected from the session.
  • add-remote-description: Emitted when a description arrives.
  • add-candidate: Emitted when a candidate arrives.
  • signaler-notify: Emitted when any notification needs to be sent to the bus.
  • error-connection: Emitted when the signaler has an error in one of the methods.

Detailed methods

connect
connect(GstBaseSignaler * self)
Parameters
self: The concrete signaler
Returns
True if connection was successful.
is_connect
is_connect(GstBaseSignaler * self)
Parameters
self: The concrete signaler
Returns
True if the signaler is connected.
disconnect
disconnect(GstBaseSignaler * self)
Parameters
self: The concrete signaler.
Returns
True if disconnection was successful.
send_local_description
send_local_description(GstBaseSignaler * self, gchar * description, GstWebRTCSDPType type)
Parameters
self: The concrete signaler.
description: The local description SDP to send.
type: SDP type offer/answer.
Returns
gboolean -> True or False if sending operation was successful.
send_candidate
send_candidate(GstBaseSignaler * self, const gchar * mid, gint sdpmlineindex, gchar * candidate)
Parameters
self: The concrete signaler.
mid: Mid of the media description this candidate is associated with.
sdpmlineindex:Index of the media description this candidate is associated with.
candidate: The standalone candidate to add.
Returns
gboolean -> True or False if sending operation was successful.


Previous: Architecture/GstWebRTCWrapperBin_Modules Index Next: Architecture/GstWebRTCWrapperBin_PubnubSignaler