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

From RidgeRun Developer Connection
Jump to: navigation, search
m
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
−
{{GStreamer WebRTC Wrapper/Head|next=XirsysIceServer|previous=BaseSignaler|keywords=}}
+
{{GStreamer WebRTC Wrapper/Head|next=Architecture/GstWebRTCWrapperBin_XirsysIceServer|previous=Architecture/GstWebRTCWrapperBin_PubnubSignaler|metakeywords=}}
 
</noinclude>
 
</noinclude>
  
 
=== BaseIceServers ===
 
=== BaseIceServers ===
 +
 +
 +
===GstIceServerClass===
  
 
The module to handle the ice serving mechanisms.
 
The module to handle the ice serving mechanisms.
  
 
==== Methods ====
 
==== Methods ====
 +
* '''connect(GstIceServer * ice_server, GError ** error)''': Connects to ice server
 +
* '''disconnect(GstIceServer * ice_server)''': Disconnect to ice server.
 +
* '''get_username(GstIceServer * ice_server)''': Gets username from ice server.
 +
* '''get_credential(GstIceServer * ice_server)''': Gets credentials from ice server.
 +
* '''get_stun_servers(GstIceServer * ice_server)''': Returns the list of STUN servers.
 +
* '''get_turn_servers(GstIceServer * ice_server)''': Returns the list of TURN servers.
 +
 +
==== Detailed methods ====
 +
 +
=====connect=====
 +
 +
<pre>
 +
connect(GstIceServer * ice_server, GError ** error)
 +
</pre>
 +
;Parameters
 +
:''ice_server:'' Ice Server instance.
 +
:''error:'': error code.
 +
;Returns
 +
:Returns: TRUE if the disconnect was success, Otherwise FALSE alongside the GError.
 +
 +
=====disconnect=====
 +
 +
<pre>
 +
gst_ice_server_disconnect (GstIceServer * ice_server)
 +
</pre>
 +
;Parameters
 +
:''ice_server:'' Ice Server instance.
 +
;Returns
 +
:TRUE if the disconnect was success.
 +
 +
=====get_stun=====
 +
 +
<pre>
 +
gst_ice_server_get_stun (GstIceServer * ice_server)
 +
</pre>
 +
;Parameters
 +
:''ice_server:'' Ice Server instance.
 +
;Returns
 +
:(transfer full) (nullable): STUN URL string.
 +
 +
=====get_turn=====
 +
 +
<pre>
 +
gst_ice_server_get_turn (GstIceServer * ice_server)
 +
</pre>
 +
;Parameters
 +
:''ice_server:'' Ice Server instance.
 +
;Returns
 +
:(transfer full) (nullable): TURN URL string.
 +
 +
=====get_username=====
 +
 +
<pre>
 +
gst_ice_server_get_username (GstIceServer * ice_server)
 +
</pre>
 +
;Parameters
 +
:''ice_server:'' Ice Server instance.
 +
;Returns
 +
:(transfer full) (nullable): username string.
 +
 +
=====get_credential=====
  
−
* '''get_stun_servers()''': Returns the list of STUN servers.
+
<pre>
−
* '''get_turn_servers()''': Returns the list of TURN servers.
+
gst_ice_server_get_credential (GstIceServer * ice_server)
 +
</pre>
 +
;Parameters
 +
:''ice_server:'' Ice Server instance.
 +
;Returns  
 +
:(transfer full) (nullable): username string.
  
  
−
<noinclude>{{GStreamer WebRTC Wrapper/Foot|BaseSignaler|XirsysIceServer}}</noinclude>
+
<noinclude>{{GStreamer WebRTC Wrapper/Foot|Architecture/GstWebRTCWrapperBin_PubnubSignaler|Architecture/GstWebRTCWrapperBin_XirsysIceServer}}</noinclude>
  
 
[[Category:GStreamer WebRTC Wrapper]]
 
[[Category:GStreamer WebRTC Wrapper]]

Latest revision as of 09:51, 1 March 2023




Previous: Architecture/GstWebRTCWrapperBin_PubnubSignaler Index Next: Architecture/GstWebRTCWrapperBin_XirsysIceServer


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



BaseIceServers

GstIceServerClass

The module to handle the ice serving mechanisms.

Methods

  • connect(GstIceServer * ice_server, GError ** error): Connects to ice server
  • disconnect(GstIceServer * ice_server): Disconnect to ice server.
  • get_username(GstIceServer * ice_server): Gets username from ice server.
  • get_credential(GstIceServer * ice_server): Gets credentials from ice server.
  • get_stun_servers(GstIceServer * ice_server): Returns the list of STUN servers.
  • get_turn_servers(GstIceServer * ice_server): Returns the list of TURN servers.

Detailed methods

connect
connect(GstIceServer * ice_server, GError ** error)
Parameters
ice_server: Ice Server instance.
error:: error code.
Returns
Returns: TRUE if the disconnect was success, Otherwise FALSE alongside the GError.
disconnect
gst_ice_server_disconnect (GstIceServer * ice_server)
Parameters
ice_server: Ice Server instance.
Returns
TRUE if the disconnect was success.
get_stun
gst_ice_server_get_stun (GstIceServer * ice_server)
Parameters
ice_server: Ice Server instance.
Returns
(transfer full) (nullable): STUN URL string.
get_turn
gst_ice_server_get_turn (GstIceServer * ice_server)
Parameters
ice_server: Ice Server instance.
Returns
(transfer full) (nullable): TURN URL string.
get_username
gst_ice_server_get_username (GstIceServer * ice_server)
Parameters
ice_server: Ice Server instance.
Returns
(transfer full) (nullable): username string.
get_credential
gst_ice_server_get_credential (GstIceServer * ice_server)
Parameters
ice_server: Ice Server instance.
Returns
(transfer full) (nullable): username string.


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