Difference between revisions of "GstWebRTC - API Reference"
Jcaballero (talk | contribs) |
Jcaballero (talk | contribs) |
||
| Line 44: | Line 44: | ||
<br> | <br> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
;Returns | ;Returns | ||
:True if connection was successful. | :True if connection was successful. | ||
| Line 54: | Line 54: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
;Returns | ;Returns | ||
:True if disconnection was successful. | :True if disconnection was successful. | ||
| Line 65: | Line 65: | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
| − | :sdp: The GstSDPMessage helper class instance. | + | :''sdp:'' The GstSDPMessage helper class instance. |
| − | :type: | + | :''type:'' |
;Returns | ;Returns | ||
:True if spd sent succesfully was successful. | :True if spd sent succesfully was successful. | ||
| Line 78: | Line 78: | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
| − | :candidates: | + | :''candidates:'' |
;Returns | ;Returns | ||
:True if sent candidates succesfully was successful. | :True if sent candidates succesfully was successful. | ||
| Line 91: | Line 91: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
| Line 100: | Line 100: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
| Line 109: | Line 109: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
| Line 118: | Line 118: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
| − | :type: | + | :''type:'' |
| − | :sdp: | + | :''sdp:'' |
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
| Line 129: | Line 129: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
| − | :sdp_index | + | :''sdp_index'' |
| − | : | + | :''sdp:'' |
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
| Line 140: | Line 140: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :self: The base class | + | :''self:'' The base class |
;Returns | ;Returns | ||
:Nothing | :Nothing | ||
}} | }} | ||
Revision as of 14:54, 20 September 2017
| ← |
⌂ Home |
→ |
Contents
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
| ← |
⌂ Home |
→ |
