Difference between revisions of "GStreamer WebRTC Wrapper/Architecture/GstWebRTCWrapperBin OWRSignaler"

From RidgeRun Developer Connection
Jump to: navigation, search
Line 3: Line 3:
 
</noinclude>
 
</noinclude>
  
−
=== BaseSignaler ===
+
=== OWRSignaler ===
  
−
===GstBaseSignalerClass===
+
===GstOwrSignalerClass===
  
 
This module handles the signaling mechanism to negotiate.
 
This module handles the signaling mechanism to negotiate.
Line 11: Line 11:
 
==== Methods ====
 
==== Methods ====
  
−
* '''connect(GstBaseSignaler * self)''': Connect to signaling server.
+
* '''connect(GstBaseSignaler * parent)''': Connect to signaling server.
−
* '''disconnect(GstBaseSignaler * self)''': Disconnect from signaling server.
+
* '''disconnect(GstBaseSignaler * parent)''': Disconnect from signaling server.
−
* '''is_connect(GstBaseSignaler * self)''': Check whether there is a connection to signaling server.
+
* '''is_connected(GstBaseSignaler * parent)''': 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_local_description(GstBaseSignaler * parent, gchar * local_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.
+
* '''send_candidate(GstBaseSignaler * parent, const gchar * mid, gint sdp_mline_index, gchar * candidate)''': Send the candidate through signaling.
 +
* '''gst_owr_signaler_set_property(GObject * object, guint property_id, const GValue * value, GParamSpec * pspec)''': ADD DESCRIPTION.
 +
* '''gst_owr_signaler_get_property(GObject * object, guint property_id, const GValue * value, GParamSpec * pspec)''': ADD DESCRIPTION.
 +
* '''gst_owr_signaler_clean_soup_session(GstOwrSignaler * owr)''': Check if Data Stream is running and destroy libsoup resources.
 +
* '''gst_owr_signaler_get_property()''': ADD DESCRIPTION.
 +
 
  
 
==== Signals ====
 
==== Signals ====

Revision as of 10:45, 24 January 2023




Previous: Architecture/GstWebRTCWrapperBin_XirsysIceServer Index Next: Evaluating_GstWebRTCWrapper


GStreamer WebRTC Wrapper
Webrtc wrapper.png
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_connected(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.
  • gst_owr_signaler_set_property(GObject * object, guint property_id, const GValue * value, GParamSpec * pspec): ADD DESCRIPTION.
  • gst_owr_signaler_get_property(GObject * object, guint property_id, const GValue * value, GParamSpec * pspec): ADD DESCRIPTION.
  • gst_owr_signaler_clean_soup_session(GstOwrSignaler * owr): Check if Data Stream is running and destroy libsoup resources.
  • gst_owr_signaler_get_property(): ADD DESCRIPTION.


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
gboolean -> True or False if sending operation was successful.
send_candidate
send_candidate(GstBaseSignaler * self, const gchar * mid, gint sdpmlineindex, gchar * candidate)
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.


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