Difference between revisions of "GStreamer WebRTC Wrapper/Architecture/GstWebRTCWrapperBin BaseSignaler"
| Line 36: | Line 36: | ||
:''self:'' The concrete signaler | :''self:'' The concrete signaler | ||
;Returns | ;Returns | ||
| − | :True if | + | :True if connection was successful. |
=====is_connect===== | =====is_connect===== | ||
| Line 46: | Line 46: | ||
:''self:'' The concrete signaler | :''self:'' The concrete signaler | ||
;Returns | ;Returns | ||
| − | :True if | + | :True if the signaler is connected. |
=====disconnect===== | =====disconnect===== | ||
| Line 54: | Line 54: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :''self:'' The concrete signaler | + | :''self:'' The concrete signaler. |
;Returns | ;Returns | ||
:True if disconnection was successful. | :True if disconnection was successful. | ||
| Line 64: | Line 64: | ||
</pre> | </pre> | ||
;Parameters | ;Parameters | ||
| − | :''self:'' The concrete signaler | + | :''self:'' The concrete signaler. |
| + | :''description:'' The local description SDP to send. | ||
| + | :''type:'' SDP type offer/answer. | ||
;Returns | ;Returns | ||
:True if disconnection was successful. | :True if disconnection was successful. | ||
| Line 75: | Line 77: | ||
;Parameters | ;Parameters | ||
:''self:'' The concrete signaler | :''self:'' The concrete signaler | ||
| + | :''mid | ||
;Returns | ;Returns | ||
:True if disconnection was successful. | :True if disconnection was successful. | ||
Revision as of 12:06, 20 January 2023
| GStreamer WebRTC Wrapper |
|---|
 |
| Introduction |
| Architecture |
| Evaluating GstWebRTCWrapper |
| Getting the Code |
| GStreamer Pipelines |
| Other WebRTC RidgeRun products |
| Contact Us |
Contents
BaseSignaler
GstBaseSignalerClass
This module handles the signaling mechanism to negotiate.
Methods
- connect(GstBaseSignaler * self): Connect to signaling server.
- disconnect(GstBaseSignaler * self): Disconnect from signaling server.
- is_connect(GstBaseSignaler * self): Check whether there is a connection to signaling server.
- send_local_description(GstBaseSignaler * self, gchar * description, GstWebRTCSDPType type): Send the local description through signaling.
- send_candidate(GstBaseSignaler * self, const gchar * mid, gint sdpmlineindex, gchar * candidate): Send the candidate through signaling.
Signals
- connected: Emitted when a peer is connected to the same session.
- disconnected: Emitted when the peer is disconnected from the session.
- add-remote-description: Emitted when a description arrives.
- add-candidate: Emitted when a candidate arrives.
- signaler-notify: Emitted when any notification needs to be sent to the bus.
- error-connection: Emitted when the signaler has an error in one of the methods.
Detailed methods
connect
connect(GstBaseSignaler * self)
- Parameters
- self: The concrete signaler
- Returns
- True if connection was successful.
is_connect
is_connect(GstBaseSignaler * self)
- Parameters
- self: The concrete signaler
- Returns
- True if the signaler is connected.
disconnect
disconnect(GstBaseSignaler * self)
- Parameters
- self: The concrete signaler.
- Returns
- True if disconnection was successful.
send_local_description
send_local_description(GstBaseSignaler * self, gchar * description, GstWebRTCSDPType type)
- Parameters
- self: The concrete signaler.
- description: The local description SDP to send.
- type: SDP type offer/answer.
- Returns
- True if disconnection was successful.
send_candidate
send_candidate(GstBaseSignaler * self, const gchar * mid, gint sdpmlineindex, gchar * candidate)
- Parameters
- self: The concrete signaler
- mid
- Returns
- True if disconnection was successful.
