GstWebRTC - API Reference: Difference between revisions
Jcaballero (talk | contribs) No edit summary |
Jcaballero (talk | contribs) No edit summary |
||
Line 23: | Line 23: | ||
;[[GstWebRTC_-_API_Reference#GstBaseSignalerSdpType|GstBaseSignalerSdpType]] type | ;[[GstWebRTC_-_API_Reference#GstBaseSignalerSdpType|GstBaseSignalerSdpType]] type | ||
:Type of SDP | :Type of SDP | ||
<br> | |||
---- | ---- | ||
<br> | |||
===GstBaseSignalerSdpType=== | ===GstBaseSignalerSdpType=== | ||
;GST_BASE_SIGNALER_SDP_OFFER | ;GST_BASE_SIGNALER_SDP_OFFER | ||
Line 47: | Line 48: | ||
;Returns | ;Returns | ||
:True if connection was successful. | :True if connection was successful. | ||
---- | |||
===Disconnect=== | ===Disconnect=== | ||
Disconnect from signaling. | Disconnect from signaling. | ||
Line 57: | Line 58: | ||
;Returns | ;Returns | ||
:True if disconnection was successful. | :True if disconnection was successful. | ||
---- | |||
===Send SDP=== | ===Send SDP=== | ||
Send sdp to the signaling. | Send sdp to the signaling. | ||
Line 70: | Line 71: | ||
;Returns | ;Returns | ||
:True if spd sent succesfully was successful. | :True if spd sent succesfully was successful. | ||
---- | |||
===Send Candidates=== | ===Send Candidates=== | ||
Send candidates to the signaling. | Send candidates to the signaling. | ||
Line 82: | Line 83: | ||
;Returns | ;Returns | ||
:True if sent candidates succesfully was successful. | :True if sent candidates succesfully was successful. | ||
---- | |||
==Signals== | ==Signals== | ||
Line 94: | Line 95: | ||
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
---- | |||
===Peer Connected=== | ===Peer Connected=== | ||
<pre> | <pre> | ||
Line 103: | Line 104: | ||
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
---- | |||
===Peer Disconnected=== | ===Peer Disconnected=== | ||
<pre> | <pre> | ||
Line 112: | Line 113: | ||
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
---- | |||
===Peer SDP=== | ===Peer SDP=== | ||
<pre> | <pre> | ||
Line 123: | Line 124: | ||
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
---- | |||
===Peer Candidate=== | ===Peer Candidate=== | ||
<pre> | <pre> | ||
Line 134: | Line 135: | ||
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
---- | |||
===Signaling Error=== | ===Signaling Error=== | ||
<pre> | <pre> |
Revision as of 19:51, 20 September 2017
← |
⌂ Home |
→ |
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
- sd
- Returns
- Nothing
Signaling Error
void (*signaling_error) (GstBaseSignaler *self)
- Parameters
- self: The base class
- Returns
- Nothing
← |
⌂ Home |
→ |