GstWebRTC - API Reference: Difference between revisions

From RidgeRun Developer Wiki
No edit summary
No edit summary
Line 27: Line 27:
;GST_BASE_SIGNALER_SDP_OFFER
;GST_BASE_SIGNALER_SDP_OFFER
:
:
<br>
;GST_BASE_SIGNALER_SDP_ANSWER
;GST_BASE_SIGNALER_SDP_ANSWER
:
:
<br>
;GST_BASE_SIGNALER_SDP_UNKNOWN
;GST_BASE_SIGNALER_SDP_UNKNOWN
:
:
 
<br>
==Virtual Functions==
==Virtual Functions==
The subclass must implement the following functions, these functions are called by the base class.
The subclass must implement the following functions, these functions are called by the base class.
Line 92: Line 94:
:Nothing
:Nothing
    
    
===Peer connected===
===Peer Connected===
<pre>
<pre>
void (*peer_connected) (GstBaseSignaler *self)
void (*peer_connected) (GstBaseSignaler *self)
Line 101: Line 103:
:Nothing
:Nothing


===Peer disconnected===
===Peer Disconnected===
<pre>
<pre>
void (*peer_disconnected) (GstBaseSignaler *self)
void (*peer_disconnected) (GstBaseSignaler *self)

Revision as of 19:03, 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
GstBaseSignaler: The base class
Returns
True if connection was successful.

Disconnect

Disconnect from signaling.

gboolean  (*disconnect) (GstBaseSignaler *self)
Parameters
GstBaseSignaler: 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
GstBaseSignaler: The base class
GstSDPMessage:
GstBaseSignalerSdpType:
Returns
True if spd sent succesfully was successful.

Send Candidates

Send candidates to the signaling.

gboolean  (*send_candidates) (GstBaseSignaler *self, GstSDPMessage *candidates)
Parameters
GstBaseSignaler: The base class
GstSDPMessage:
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
GstBaseSignaler: The base class
Returns
Nothing

Peer Connected

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

Peer Disconnected

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

Peer SDP

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

Peer Candidate

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

Signaling Error

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


Custom Signalers


Home

Plugin Elements