Difference between revisions of "GstWebRTC - API Reference"

From RidgeRun Developer Connection
Jump to: navigation, search
Line 11: Line 11:
 
;guint id
 
;guint id
 
:The ID of the local endpoint  
 
:The ID of the local endpoint  
<br>
+
 
 
;gchar *peer_id
 
;gchar *peer_id
 
:The ID of the remote endpoint
 
:The ID of the remote endpoint
<br>
+
 
 
;gboolean peer_connected
 
;gboolean peer_connected
 
:True if peer is connected
 
:True if peer is connected
<br>
+
 
 
;[https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-GstSDPMessage.html GstSDPMessage] *peer_sdp
 
;[https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-GstSDPMessage.html GstSDPMessage] *peer_sdp
 
:Instance of GstSDPMessage class
 
:Instance of GstSDPMessage class
<br>
+
 
 
;[[GstWebRTC_-_API_Reference#GstBaseSignalerSdpType|GstBaseSignalerSdpType]] type
 
;[[GstWebRTC_-_API_Reference#GstBaseSignalerSdpType|GstBaseSignalerSdpType]] type
 
:Type of SDP
 
:Type of SDP

Revision as of 15:13, 20 September 2017


Custom Signalers


Home

Plugin Elements



Classes, Structs and Enums

GstBaseSignaler Class

Base class for custom signalers.

Members

guint id
The ID of the local endpoint
gchar *peer_id
The ID of the remote endpoint
gboolean peer_connected
True if peer is connected
GstSDPMessage *peer_sdp
Instance of GstSDPMessage class
GstBaseSignalerSdpType type
Type of SDP



GstBaseSignalerSdpType

  • GST_BASE_SIGNALER_SDP_OFFER


  • GST_BASE_SIGNALER_SDP_ANSWER


  • GST_BASE_SIGNALER_SDP_UNKNOWN


Virtual Functions

The subclass must implement the following functions, these functions are called by the base class.

Connect

gboolean  (*connect) (GstBaseSignaler *self)

Connect to signaling from subclasses.

Parameters
self: The base class
Returns
True if connection was successful.

Disconnect

Disconnect from signaling.

gboolean  (*disconnect) (GstBaseSignaler *self)
Parameters
self: The base class
Returns
True if disconnection was successful.

Send SDP

Send sdp to the signaling.

gboolean  (*send_sdp) (GstBaseSignaler *self, GstSDPMessage *sdp, GstBaseSignalerSdpType type)
Parameters
self: The base class
sdp: The GstSDPMessage helper class instance.
type:
Returns
True if spd sent succesfully was successful.

Send Candidates

Send candidates to the signaling.

gboolean  (*send_candidates) (GstBaseSignaler *self, GstSDPMessage *candidates)
Parameters
self: The base class
candidates:
Returns
True if sent candidates succesfully was successful.

Signals

The following signals must be emitted by the subclass:

Signaling bound

void (*signaling_bound) (GstBaseSignaler *self)
Parameters
self: The base class
Returns
Nothing

Peer Connected

void (*peer_connected) (GstBaseSignaler *self)
Parameters
self: The base class
Returns
Nothing

Peer Disconnected

void (*peer_disconnected) (GstBaseSignaler *self)
Parameters
self: The base class
Returns
Nothing

Peer SDP

void (*peer_sdp) (GstBaseSignaler *self, GstBaseSignalerSdpType * type, GstSDPMessage * sdp)
Parameters
self: The base class
type:
sdp:
Returns
Nothing

Peer Candidate

void (*peer_candidate) (GstBaseSignaler *self, gint sdp_index, gchar * sdp)
Parameters
self: The base class
sdp_index
sdp:
Returns
Nothing

Signaling Error

void (*signaling_error) (GstBaseSignaler *self)
Parameters
self: The base class
Returns
Nothing


Custom Signalers


Home

Plugin Elements