GStreamer WebRTC Wrapper/Architecture/GstWebRTCWrapperBin OWRSignaler: Difference between revisions

From RidgeRun Developer Wiki
No edit summary
No edit summary
Line 11: Line 11:
==== Methods ====
==== Methods ====


* '''gst_owr_signaler_clean_soup_session(GstOwrSignaler * owr)''': Check if Data Stream is running and destroy libsoup resources.
* '''connect(GstBaseSignaler * parent)''': Connect to signaling server.
* '''gst_owr_sdp_sent(SoupSession * session, GAsyncResult * result, gpointer user_data)''': ADD DESCRIPTION.
* '''disconnect(GstBaseSignaler * parent)''': Disconnect from signaling server.
* '''gst_owr_signaler_url_server_check(GstOwrSignaler * owr)''': Checks if URL Server exists and if it is valid.
* '''is_connect(GstBaseSignaler * parent)''': Check whether there is a connection to signaling server.
* '''gst_owr_eventstream_line_read(GDataInputStream * input_stream, GAsyncResult * result, gpointer user_data)''': ADD DESCRIPTION.
* '''send_local_description(GstBaseSignaler * parent, gchar * local_description, GstWebRTCSDPType type)''': Send the local description through signaling.
* '''gst_owr_read_eventstream_line(GDataInputStream * input_stream, gpointer user_data)''': ADD DESCRIPTION.
* '''send_candidate(GstBaseSignaler * parent, const gchar * mid, gint sdp_mline_index, gchar * candidate)''': Send the candidate through signaling.
* '''gst_owr_async_request_sent(SoupSession * session, GAsyncResult * result, gpointer user_data)''': ADD DESCRIPTION.
* '''gst_owr_append_auth(SoupMessage * msg, const gchar * api_token)''': ADD DESCRIPTION.
* '''gst_owr_send_async_request(GstOwrSignaler * owr)''': ADD DESCRIPTION.
* '''gst_owr_signaler_event_join(GstOwrSignaler * owr, gchar * data)''': ADD DESCRIPTION.
* '''gst_owr_signaler_event_leave(GstOwrSignaler * owr, gchar * data)''': ADD DESCRIPTION.
* '''gst_owr_signaler_event_user(GstOwrSignaler * owr, gchar * data)''': ADD DESCRIPTION.
* '''gst_owr_signaler_event_busy(GstOwrSignaler * owr, gchar * data)''': ADD DESCRIPTION.


==== Signals ====
==== Signals ====
Line 32: Line 25:
*  ''signaler-notify'': Emitted when any notification needs to be sent to the bus.
*  ''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.
*  ''error-connection'': Emitted when the signaler has an error in one of the methods.
==== Detailed methods ====
=====connect=====
<pre>
connect(GstBaseSignaler * self)
</pre>
;Parameters
:''self:'' The concrete signaler
;Returns
:True if connection was successful.
=====is_connect=====
<pre>
is_connect(GstBaseSignaler * self)
</pre>
;Parameters
:''self:'' The concrete signaler
;Returns
:True if the signaler is connected.
=====disconnect=====
<pre>
disconnect(GstBaseSignaler * self)
</pre>
;Parameters
:''self:'' The concrete signaler.
;Returns
:True if disconnection was successful.
=====send_local_description=====
<pre>
send_local_description(GstBaseSignaler * self, gchar * description, GstWebRTCSDPType type)
</pre>
;Parameters
:''self:'' The concrete signaler.
:''description:'' The local description SDP to send.
:''type:'' SDP type offer/answer.
;Returns
:gboolean -> True or False if sending operation was successful.
=====send_candidate=====
<pre>
send_candidate(GstBaseSignaler * self, const gchar * mid, gint sdpmlineindex, gchar * candidate)
</pre>
;Parameters
:''self:'' The concrete signaler.
:''mid:'' Mid of the media description this candidate is associated with.
:''sdpmlineindex:''Index of the media description this candidate is associated with.
:''candidate:'' The standalone candidate to add.
;Returns
:gboolean -> True or False if sending operation was successful.




Revision as of 18:52, 24 January 2023




Previous: Architecture/GstWebRTCWrapperBin_XirsysIceServer Index Next: Evaluating_GstWebRTCWrapper


GStreamer WebRTC Wrapper
Introduction
Architecture
Evaluating GstWebRTCWrapper
Getting the Code
GStreamer Pipelines
Other WebRTC RidgeRun products
Contact Us



OWRSignaler

GstOwrSignalerClass

This module handles the signaling mechanism to negotiate.

Methods

  • connect(GstBaseSignaler * parent): Connect to signaling server.
  • disconnect(GstBaseSignaler * parent): Disconnect from signaling server.
  • is_connect(GstBaseSignaler * parent): Check whether there is a connection to signaling server.
  • send_local_description(GstBaseSignaler * parent, gchar * local_description, GstWebRTCSDPType type): Send the local description through signaling.
  • send_candidate(GstBaseSignaler * parent, const gchar * mid, gint sdp_mline_index, 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.


Previous: Architecture/GstWebRTCWrapperBin_XirsysIceServer Index Next: Evaluating_GstWebRTCWrapper
Retrieved from "https://developer.ridgerun.com/wiki/index.php?title=GStreamer_WebRTC_Wrapper/Architecture/GstWebRTCWrapperBin_OWRSignaler&oldid=45935"