GstWebRTC - API Reference: Difference between revisions

Revision as of 18:53, 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

GstBaseSignalerSdpType type

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

@@ Line 54: / Line 54: @@
 ;Returns
 :True if disconnection was successful.
-'''gboolean  (*send_sdp) (GstBaseSignaler *self, GstSDPMessage *sdp, GstBaseSignalerSdpType type)'''<br>
-Send sdp to the signaling.<br><br>
-'''gboolean  (*send_candidates) (GstBaseSignaler *self, GstSDPMessage *candidates)'''<br>
+===Send SDP===
-Send candidates to the signaling.<br><br>
+Send sdp to the signaling.
+<pre>
+gboolean  (*send_sdp) (GstBaseSignaler *self, GstSDPMessage *sdp, GstBaseSignalerSdpType type)
+</pre>
+;Parameters
+:GstBaseSignaler: The base class
+:GstSDPMessage:
+:GstBaseSignalerSdpType:
+;Returns
+:True if spd sent succesfully was successful.
+===Send Candidates===
+Send candidates to the signaling.
+<pre>
+gboolean  (*send_candidates) (GstBaseSignaler *self, GstSDPMessage *candidates)
+</pre>
+;Parameters
+:GstBaseSignaler: The base class
+:GstSDPMessage:
+;Returns
+:True if sent candidates succesfully was successful.
 ==Signals==
 The following signals must be emitted by the subclass:<br>
-'''void (*signaling_bound) (GstBaseSignaler *self)'''<br>
+===Signaling bound===
-<br>
+<pre>
-'''void (*peer_connected) (GstBaseSignaler *self)'''<br>
+void (*signaling_bound) (GstBaseSignaler *self)
-<br>
+</pre>
-'''void (*peer_disconnected) (GstBaseSignaler *self)'''<br>
+;Parameters
-<br>
+:GstBaseSignaler: The base class
-'''void (*peer_sdp) (GstBaseSignaler *self, GstBaseSignalerSdpType * type, GstSDPMessage * sdp)'''<br>
+;Returns
-<br>
+:Nothing
-'''void (*peer_candidate) (GstBaseSignaler *self, gint sdp_index, gchar * sdp)'''<br>
-<br>
+===Peer connected===
-'''void (*signaling_error) (GstBaseSignaler *self)'''<br>
+<pre>
-<br>
+void (*peer_connected) (GstBaseSignaler *self)
+</pre>
+;Parameters
+:GstBaseSignaler: The base class
+;Returns
+:Nothing
+===Peer disconnected===
+<pre>
+void (*peer_disconnected) (GstBaseSignaler *self)
+</pre>
+;Parameters
+:GstBaseSignaler: The base class
+;Returns
+:Nothing
+===Peer SDP===
+<pre>
+void (*peer_sdp) (GstBaseSignaler *self, GstBaseSignalerSdpType * type, GstSDPMessage * sdp)
+</pre>
+;Parameters
+:GstBaseSignaler self: The base class
+:GstSDPMessage:
+;Returns
+:Nothing
+===Peer Candidate===
+<pre>
+void (*peer_candidate) (GstBaseSignaler *self, gint sdp_index, gchar * sdp)
+</pre>
+;Parameters
+:GstBaseSignaler self: The base class
+:gint sdp_index
+:gchar * sd
+;Returns
+:Nothing
+===Signaling Error===
+<pre>
+void (*signaling_error) (GstBaseSignaler *self)
+</pre>
+;Parameters
+:GstBaseSignaler self: The base class
+;Returns
+:Nothing
 }}