GstWebRTC - API Reference: Difference between revisions

From RidgeRun Developer Wiki
No edit summary
No edit summary
Line 3: Line 3:
[[GstWebRTC - Elements | Plugin Elements]]|
[[GstWebRTC - Elements | Plugin Elements]]|


==Classes, Structs and Enums==
==GstBaseSignaler Class==
==GstBaseSignaler Class==
Base class for custom signalers. <br>
Base class for custom signalers. <br>
Class struct:
   GObject parent;
   GObject parent;
   guint id;
   guint id;
Line 12: Line 14:
   GstBaseSignalerSdpType type;
   GstBaseSignalerSdpType type;


===SDP Types===
==GstBaseSignalerSdpType Class==
 
===SDP Types Enum===
   GST_BASE_SIGNALER_SDP_OFFER,
   GST_BASE_SIGNALER_SDP_OFFER,
   GST_BASE_SIGNALER_SDP_ANSWER,
   GST_BASE_SIGNALER_SDP_ANSWER,
   GST_BASE_SIGNALER_SDP_UNKNOWN,
   GST_BASE_SIGNALER_SDP_UNKNOWN,


===Virtual Functions===
==Virtual Functions==
The subclass must implement the following functions, these functions are called by the base class<br><br>
The subclass must implement the following functions, these functions are called by the base class<br><br>
'''gboolean  (*connect) (GstBaseSignaler *self)'''
'''gboolean  (*connect) (GstBaseSignaler *self)'''
Line 33: Line 37:
    
    


===Signals===
==Signals==
The following signals must be emitted by the subclass:
The following signals must be emitted by the subclass:
   void      (*signaling_bound)  (GstBaseSignaler *self);
   void      (*signaling_bound)  (GstBaseSignaler *self);

Revision as of 18:18, 20 September 2017


Custom Signalers


Home

Plugin Elements



Classes, Structs and Enums

GstBaseSignaler Class

Base class for custom signalers.
Class struct:

 GObject parent;
 guint id;
 gchar *peer_id;
 gboolean peer_connected;
 GstSDPMessage *peer_sdp;
 GstBaseSignalerSdpType type;

GstBaseSignalerSdpType Class

SDP Types Enum

 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

gboolean (*connect) (GstBaseSignaler *self)
Connect to signaling from subclasses

gboolean (*disconnect) (GstBaseSignaler *self)
Disconnect from signaling.

gboolean (*send_sdp) (GstBaseSignaler *self, GstSDPMessage *sdp, GstBaseSignalerSdpType type)
Send sdp to the signaling.

gboolean (*send_candidates) (GstBaseSignaler *self, GstSDPMessage *candidates)
Send candidates to the signaling.


Signals

The following signals must be emitted by the subclass:

 void      (*signaling_bound)   (GstBaseSignaler *self);
 void      (*peer_connected)    (GstBaseSignaler *self);
 void      (*peer_disconnected) (GstBaseSignaler *self);
 void      (*peer_sdp)          (GstBaseSignaler *self, GstBaseSignalerSdpType * type, GstSDPMessage * sdp);
 void      (*peer_candidate)    (GstBaseSignaler *self, gint sdp_index, gchar * sdp);
 void      (*signaling_error)   (GstBaseSignaler *self);


Custom Signalers


Home

Plugin Elements