Fork me on GitHub
Data Structures | Macros | Typedefs | Enumerations | Functions
ice.h File Reference

Janus handles and ICE/STUN/TURN processing (headers) More...

#include <glib.h>
#include <agent.h>
#include "sdp.h"
#include "dtls.h"
#include "sctp.h"
#include "rtcp.h"
#include "text2pcap.h"
#include "utils.h"
#include "ip-utils.h"
#include "refcount.h"
#include "plugins/plugin.h"
Include dependency graph for ice.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  janus_ice_stats_info
 Janus media statistics. More...
 
struct  janus_ice_stats
 Janus media statistics container. More...
 
struct  janus_seq_info
 A helper struct for determining when to send NACKs. More...
 
struct  janus_ice_handle
 Janus ICE handle. More...
 
struct  janus_ice_peerconnection
 Janus handle WebRTC PeerConnection. More...
 
struct  janus_ice_peerconnection_medium
 A single media in a PeerConnection. More...
 
struct  janus_ice_trickle
 Helper to handle pending trickle candidates (e.g., when we're still waiting for an offer) More...
 

Macros

#define JANUS_ICE_HANDLE_WEBRTC_PROCESSING_OFFER   (1 << 0)
 
#define JANUS_ICE_HANDLE_WEBRTC_START   (1 << 1)
 
#define JANUS_ICE_HANDLE_WEBRTC_READY   (1 << 2)
 
#define JANUS_ICE_HANDLE_WEBRTC_STOP   (1 << 3)
 
#define JANUS_ICE_HANDLE_WEBRTC_ALERT   (1 << 4)
 
#define JANUS_ICE_HANDLE_WEBRTC_NEGOTIATED   (1 << 5)
 
#define JANUS_ICE_HANDLE_WEBRTC_TRICKLE   (1 << 7)
 
#define JANUS_ICE_HANDLE_WEBRTC_ALL_TRICKLES   (1 << 8)
 
#define JANUS_ICE_HANDLE_WEBRTC_TRICKLE_SYNCED   (1 << 9)
 
#define JANUS_ICE_HANDLE_WEBRTC_DATA_CHANNELS   (1 << 10)
 
#define JANUS_ICE_HANDLE_WEBRTC_CLEANING   (1 << 11)
 
#define JANUS_ICE_HANDLE_WEBRTC_HAS_AUDIO   (1 << 12)
 
#define JANUS_ICE_HANDLE_WEBRTC_HAS_VIDEO   (1 << 13)
 
#define JANUS_ICE_HANDLE_WEBRTC_GOT_OFFER   (1 << 14)
 
#define JANUS_ICE_HANDLE_WEBRTC_GOT_ANSWER   (1 << 15)
 
#define JANUS_ICE_HANDLE_WEBRTC_HAS_AGENT   (1 << 16)
 
#define JANUS_ICE_HANDLE_WEBRTC_ICE_RESTART   (1 << 17)
 
#define JANUS_ICE_HANDLE_WEBRTC_RESEND_TRICKLES   (1 << 18)
 
#define JANUS_ICE_HANDLE_WEBRTC_RFC4588_RTX   (1 << 19)
 
#define JANUS_ICE_HANDLE_WEBRTC_NEW_DATACHAN_SDP   (1 << 20)
 
#define JANUS_ICE_HANDLE_WEBRTC_E2EE   (1 << 21)
 
#define LAST_SEQS_MAX_LEN   160
 

Typedefs

typedef struct janus_ice_handle janus_ice_handle
 Janus ICE handle in a session. More...
 
typedef struct janus_ice_peerconnection janus_ice_peerconnection
 WebRTC PeerConnection associated to a specific handle. More...
 
typedef struct janus_ice_peerconnection_medium janus_ice_peerconnection_medium
 A single medium (i.e., m-line) in a Janus handle PeerConnection: can be bidirectional. More...
 
typedef struct janus_ice_trickle janus_ice_trickle
 Helper to handle pending trickle candidates (e.g., when we're still waiting for an offer) More...
 
typedef enum janus_media_type janus_media_type
 Janus media types. More...
 
typedef struct janus_ice_stats_info janus_ice_stats_info
 Janus media statistics. More...
 
typedef struct janus_ice_stats janus_ice_stats
 Janus media statistics container. More...
 
typedef struct janus_seq_info janus_seq_info
 A helper struct for determining when to send NACKs. More...
 

Enumerations

enum  janus_media_type { JANUS_MEDIA_UNKNOWN = 0, JANUS_MEDIA_AUDIO, JANUS_MEDIA_VIDEO, JANUS_MEDIA_DATA }
 Janus media types. More...
 
enum  { SEQ_MISSING, SEQ_NACKED, SEQ_GIVEUP, SEQ_RECVED }
 

Functions

void janus_ice_init (gboolean ice_lite, gboolean ice_tcp, gboolean full_trickle, gboolean ignore_mdns, gboolean ipv6, uint16_t rtp_min_port, uint16_t rtp_max_port)
 ICE stuff initialization. More...
 
void janus_ice_deinit (void)
 ICE stuff de-initialization. More...
 
int janus_ice_test_stun_server (janus_network_address *addr, uint16_t port, uint16_t local_port, janus_network_address *public_addr, uint16_t *public_port)
 Method to check whether a STUN server is reachable. More...
 
int janus_ice_set_stun_server (gchar *stun_server, uint16_t stun_port)
 Method to force Janus to use a STUN server when gathering candidates. More...
 
int janus_ice_set_turn_server (gchar *turn_server, uint16_t turn_port, gchar *turn_type, gchar *turn_user, gchar *turn_pwd)
 Method to force Janus to use a TURN server when gathering candidates. More...
 
int janus_ice_set_turn_rest_api (gchar *api_server, gchar *api_key, gchar *api_method, uint api_timeout)
 Method to force Janus to contact a TURN REST API server to get a TURN service to use when gathering candidates. The TURN REST API takes precedence over any static credential passed via janus_ice_set_turn_server. More...
 
char * janus_ice_get_stun_server (void)
 Method to get the STUN server IP address. More...
 
uint16_t janus_ice_get_stun_port (void)
 Method to get the STUN server port. More...
 
char * janus_ice_get_turn_server (void)
 Method to get the TURN server IP address. More...
 
uint16_t janus_ice_get_turn_port (void)
 Method to get the TURN server port. More...
 
char * janus_ice_get_turn_rest_api (void)
 Method to get the specified TURN REST API backend, if any. More...
 
void janus_ice_enable_nat_1_1 (gboolean keep_private_host)
 Helper method to force Janus to overwrite all host candidates with the public IP. More...
 
void janus_ice_enforce_interface (const char *ip)
 Method to add an interface/IP to the enforce list for ICE (that is, only gather candidates from these and ignore the others) More...
 
gboolean janus_ice_is_enforced (const char *ip)
 Method to check whether an interface is currently in the enforce list for ICE (that is, won't have candidates) More...
 
void janus_ice_ignore_interface (const char *ip)
 Method to add an interface/IP to the ignore list for ICE (that is, don't gather candidates) More...
 
gboolean janus_ice_is_ignored (const char *ip)
 Method to check whether an interface/IP is currently in the ignore list for ICE (that is, won't have candidates) More...
 
gboolean janus_ice_is_ice_lite_enabled (void)
 Method to check whether ICE Lite mode is enabled or not (still WIP) More...
 
gboolean janus_ice_is_ice_tcp_enabled (void)
 Method to check whether ICE-TCP support is enabled/supported or not (still WIP) More...
 
gboolean janus_ice_is_full_trickle_enabled (void)
 Method to check whether full-trickle support is enabled or not. More...
 
gboolean janus_ice_is_mdns_enabled (void)
 Method to check whether mDNS resolution is enabled or not. More...
 
gboolean janus_ice_is_ipv6_enabled (void)
 Method to check whether IPv6 candidates are enabled/supported or not. More...
 
void janus_ice_set_keepalive_conncheck_enabled (gboolean enabled)
 Method to enable/disable connectivity checks as keepalives for PeerConnections. More...
 
gboolean janus_ice_is_keepalive_conncheck_enabled (void)
 Method to check whether connectivity checks will be used as keepalives. More...
 
void janus_set_min_nack_queue (uint16_t mnq)
 Method to modify the min NACK value (i.e., the minimum time window of packets per handle to store for retransmissions) More...
 
uint16_t janus_get_min_nack_queue (void)
 Method to get the current min NACK value (i.e., the minimum time window of packets per handle to store for retransmissions) More...
 
void janus_set_nack_optimizations_enabled (gboolean optimize)
 Method to enable/disable the NACK optimizations on outgoing keyframes: when enabled, the NACK buffer for a PeerConnection is cleaned any time Janus sends a keyframe, as any missing packet won't be needed since the keyframe will allow the media recipient to still restore a complete image anyway. Since this optimization seems to cause some issues in some edge cases, it's disabled by default. More...
 
gboolean janus_is_nack_optimizations_enabled (void)
 Method to check whether NACK optimizations on outgoing keyframes are enabled or not. More...
 
void janus_set_no_media_timer (uint timer)
 Method to modify the no-media event timer (i.e., the number of seconds where no media arrives before Janus notifies this) More...
 
uint janus_get_no_media_timer (void)
 Method to get the current no-media event timer (see above) More...
 
void janus_set_slowlink_threshold (uint packets)
 Method to modify the slowlink-threshold property (i.e., the number of lost packets per seconds that should trigger a slow-link event) More...
 
uint janus_get_slowlink_threshold (void)
 Method to get the current slowlink-threshold value (see above) More...
 
void janus_set_twcc_period (uint period)
 Method to modify the TWCC feedback period (i.e., how often TWCC feedback is sent back to media senders) More...
 
uint janus_get_twcc_period (void)
 Method to get the current TWCC period (see above) More...
 
void janus_set_dscp (int dscp)
 Method to modify the DSCP value to set, which is disabled by default. More...
 
int janus_get_dscp (void)
 Method to get the current DSCP value (see above) More...
 
void janus_ice_set_event_stats_period (int period)
 Method to modify the event handler statistics period (i.e., the number of seconds that should pass before Janus notifies event handlers about media statistics for a PeerConnection) More...
 
int janus_ice_get_event_stats_period (void)
 Method to get the current event handler statistics period (see above) More...
 
gboolean janus_ice_is_ice_debugging_enabled (void)
 Method to check whether libnice debugging has been enabled (http://nice.freedesktop.org/libnice/libnice-Debug-messages.html) More...
 
void janus_ice_debugging_enable (void)
 Method to enable libnice debugging (http://nice.freedesktop.org/libnice/libnice-Debug-messages.html) More...
 
void janus_ice_debugging_disable (void)
 Method to disable libnice debugging (the default) More...
 
void janus_enable_opaqueid_in_api (void)
 Method to enable opaque ID in Janus API responses/events. More...
 
gboolean janus_is_opaqueid_in_api_enabled (void)
 Method to check whether opaque ID have to be added to Janus API responses/events. More...
 
const gchar * janus_get_ice_state_name (gint state)
 Helper method to get a string representation of a libnice ICE state. More...
 
void janus_ice_notify_hangup (janus_ice_handle *handle, const char *reason)
 Quick helper method to notify a WebRTC hangup through the Janus API. More...
 
gboolean janus_plugin_session_is_alive (janus_plugin_session *plugin_session)
 Quick helper method to check if a plugin session associated with a Janus handle is still valid. More...
 
void janus_seq_list_free (janus_seq_info **head)
 
janus_ice_peerconnection_mediumjanus_ice_peerconnection_medium_create (janus_ice_handle *handle, janus_media_type type)
 Method to quickly create a medium to be added to a handle PeerConnection. More...
 
void janus_ice_set_static_event_loops (int loops)
 Method to configure the static event loops mechanism at startup. More...
 
int janus_ice_get_static_event_loops (void)
 Method to return the number of static event loops, if enabled. More...
 
void janus_ice_stop_static_event_loops (void)
 Method to stop all the static event loops, if enabled. More...
 
Janus ICE trickle candidates methods
janus_ice_tricklejanus_ice_trickle_new (const char *transaction, json_t *candidate)
 Helper method to allocate a janus_ice_trickle instance. More...
 
gint janus_ice_trickle_parse (janus_ice_handle *handle, json_t *candidate, const char **error)
 Helper method to parse trickle candidates. More...
 
void janus_ice_trickle_destroy (janus_ice_trickle *trickle)
 Helper method to destroy a janus_ice_trickle instance. More...
 
Janus ICE handle methods
janus_ice_handlejanus_ice_handle_create (void *core_session, const char *opaque_id, const char *token)
 Method to create a new Janus ICE handle. More...
 
gint janus_ice_handle_attach_plugin (void *core_session, janus_ice_handle *handle, janus_plugin *plugin)
 Method to attach a Janus ICE handle to a plugin. More...
 
gint janus_ice_handle_destroy (void *core_session, janus_ice_handle *handle)
 Method to destroy a Janus ICE handle. More...
 
void janus_ice_webrtc_hangup (janus_ice_handle *handle, const char *reason)
 Method to only hangup (e.g., DTLS alert) the WebRTC PeerConnection allocated by a Janus ICE handle. More...
 
void janus_ice_peerconnection_destroy (janus_ice_peerconnection *pc)
 Method to only free resources related to a specific Webrtc PeerConnection allocated by a Janus ICE handle. More...
 
Janus ICE media relaying callbacks
void janus_ice_relay_rtp (janus_ice_handle *handle, janus_plugin_rtp *packet)
 Core RTP callback, called when a plugin has an RTP packet to send to a peer. More...
 
void janus_ice_relay_rtcp (janus_ice_handle *handle, janus_plugin_rtcp *packet)
 Core RTCP callback, called when a plugin has an RTCP message to send to a peer. More...
 
void janus_ice_relay_data (janus_ice_handle *handle, janus_plugin_data *packet)
 Core SCTP/DataChannel callback, called when a plugin has data to send to a peer. More...
 
void janus_ice_send_pli (janus_ice_handle *handle)
 Helper core callback, called when a plugin wants to send a RTCP PLI to a peer. More...
 
void janus_ice_send_pli_stream (janus_ice_handle *handle, int mindex)
 Helper core callback, called when a plugin wants to send a RTCP PLI to a single video stream of a peer. More...
 
void janus_ice_send_remb (janus_ice_handle *handle, uint32_t bitrate)
 Helper core callback, called when a plugin wants to send a RTCP REMB to a peer. More...
 
void janus_ice_incoming_data (janus_ice_handle *handle, char *label, char *protocol, gboolean textdata, char *buffer, int length)
 Plugin SCTP/DataChannel callback, called by the SCTP stack when when there's data for a plugin. More...
 
void janus_ice_relay_sctp (janus_ice_handle *handle, char *buffer, int length)
 Core SCTP/DataChannel callback, called by the SCTP stack when when there's data to send. More...
 
void janus_ice_notify_data_ready (janus_ice_handle *handle)
 Plugin SCTP/DataChannel callback, called by the SCTP stack when data can be written. More...
 
Janus ICE handle helpers
int janus_ice_setup_local (janus_ice_handle *handle, gboolean offer, gboolean trickle)
 Method to locally set up the ICE candidates (initialization and gathering) More...
 
void janus_ice_candidates_to_sdp (janus_ice_handle *handle, janus_sdp_mline *mline, guint stream_id, guint component_id)
 Method to add local candidates to a janus_sdp SDP object representation. More...
 
void janus_ice_add_remote_candidate (janus_ice_handle *handle, NiceCandidate *c)
 Method to queue a remote candidate for processing. More...
 
void janus_ice_setup_remote_candidates (janus_ice_handle *handle, guint stream_id, guint component_id)
 Method to handle remote candidates and start the connectivity checks. More...
 
void janus_ice_dtls_handshake_done (janus_ice_handle *handle)
 Callback to be notified when the DTLS handshake for a specific component has been completed. More...
 
void janus_ice_restart (janus_ice_handle *handle)
 Method to restart ICE and the connectivity checks. More...
 
void janus_ice_resend_trickles (janus_ice_handle *handle)
 Method to resend all the existing candidates via trickle (e.g., after an ICE restart) More...
 

Detailed Description

Janus handles and ICE/STUN/TURN processing (headers)

Author
Lorenzo Miniero loren.nosp@m.zo@m.nosp@m.eetec.nosp@m.ho.c.nosp@m.om

Protocols

Macro Definition Documentation

◆ JANUS_ICE_HANDLE_WEBRTC_ALERT

#define JANUS_ICE_HANDLE_WEBRTC_ALERT   (1 << 4)

◆ JANUS_ICE_HANDLE_WEBRTC_ALL_TRICKLES

#define JANUS_ICE_HANDLE_WEBRTC_ALL_TRICKLES   (1 << 8)

◆ JANUS_ICE_HANDLE_WEBRTC_CLEANING

#define JANUS_ICE_HANDLE_WEBRTC_CLEANING   (1 << 11)

◆ JANUS_ICE_HANDLE_WEBRTC_DATA_CHANNELS

#define JANUS_ICE_HANDLE_WEBRTC_DATA_CHANNELS   (1 << 10)

◆ JANUS_ICE_HANDLE_WEBRTC_E2EE

#define JANUS_ICE_HANDLE_WEBRTC_E2EE   (1 << 21)

◆ JANUS_ICE_HANDLE_WEBRTC_GOT_ANSWER

#define JANUS_ICE_HANDLE_WEBRTC_GOT_ANSWER   (1 << 15)

◆ JANUS_ICE_HANDLE_WEBRTC_GOT_OFFER

#define JANUS_ICE_HANDLE_WEBRTC_GOT_OFFER   (1 << 14)

◆ JANUS_ICE_HANDLE_WEBRTC_HAS_AGENT

#define JANUS_ICE_HANDLE_WEBRTC_HAS_AGENT   (1 << 16)

◆ JANUS_ICE_HANDLE_WEBRTC_HAS_AUDIO

#define JANUS_ICE_HANDLE_WEBRTC_HAS_AUDIO   (1 << 12)

◆ JANUS_ICE_HANDLE_WEBRTC_HAS_VIDEO

#define JANUS_ICE_HANDLE_WEBRTC_HAS_VIDEO   (1 << 13)

◆ JANUS_ICE_HANDLE_WEBRTC_ICE_RESTART

#define JANUS_ICE_HANDLE_WEBRTC_ICE_RESTART   (1 << 17)

◆ JANUS_ICE_HANDLE_WEBRTC_NEGOTIATED

#define JANUS_ICE_HANDLE_WEBRTC_NEGOTIATED   (1 << 5)

◆ JANUS_ICE_HANDLE_WEBRTC_NEW_DATACHAN_SDP

#define JANUS_ICE_HANDLE_WEBRTC_NEW_DATACHAN_SDP   (1 << 20)

◆ JANUS_ICE_HANDLE_WEBRTC_PROCESSING_OFFER

#define JANUS_ICE_HANDLE_WEBRTC_PROCESSING_OFFER   (1 << 0)

◆ JANUS_ICE_HANDLE_WEBRTC_READY

#define JANUS_ICE_HANDLE_WEBRTC_READY   (1 << 2)

◆ JANUS_ICE_HANDLE_WEBRTC_RESEND_TRICKLES

#define JANUS_ICE_HANDLE_WEBRTC_RESEND_TRICKLES   (1 << 18)

◆ JANUS_ICE_HANDLE_WEBRTC_RFC4588_RTX

#define JANUS_ICE_HANDLE_WEBRTC_RFC4588_RTX   (1 << 19)

◆ JANUS_ICE_HANDLE_WEBRTC_START

#define JANUS_ICE_HANDLE_WEBRTC_START   (1 << 1)

◆ JANUS_ICE_HANDLE_WEBRTC_STOP

#define JANUS_ICE_HANDLE_WEBRTC_STOP   (1 << 3)

◆ JANUS_ICE_HANDLE_WEBRTC_TRICKLE

#define JANUS_ICE_HANDLE_WEBRTC_TRICKLE   (1 << 7)

◆ JANUS_ICE_HANDLE_WEBRTC_TRICKLE_SYNCED

#define JANUS_ICE_HANDLE_WEBRTC_TRICKLE_SYNCED   (1 << 9)

◆ LAST_SEQS_MAX_LEN

#define LAST_SEQS_MAX_LEN   160

Typedef Documentation

◆ janus_ice_handle

Janus ICE handle in a session.

◆ janus_ice_peerconnection

WebRTC PeerConnection associated to a specific handle.

◆ janus_ice_peerconnection_medium

A single medium (i.e., m-line) in a Janus handle PeerConnection: can be bidirectional.

◆ janus_ice_stats

Janus media statistics container.

Note
To improve with more stuff

◆ janus_ice_stats_info

Janus media statistics.

Note
To improve with more stuff

◆ janus_ice_trickle

Helper to handle pending trickle candidates (e.g., when we're still waiting for an offer)

◆ janus_media_type

Janus media types.

◆ janus_seq_info

A helper struct for determining when to send NACKs.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
SEQ_MISSING 
SEQ_NACKED 
SEQ_GIVEUP 
SEQ_RECVED 

◆ janus_media_type

Janus media types.

Enumerator
JANUS_MEDIA_UNKNOWN 
JANUS_MEDIA_AUDIO 
JANUS_MEDIA_VIDEO 
JANUS_MEDIA_DATA 

Function Documentation

◆ janus_enable_opaqueid_in_api()

void janus_enable_opaqueid_in_api ( void  )

Method to enable opaque ID in Janus API responses/events.

◆ janus_get_dscp()

int janus_get_dscp ( void  )

Method to get the current DSCP value (see above)

Returns
The current DSCP value (0 if disabled)

◆ janus_get_ice_state_name()

const gchar* janus_get_ice_state_name ( gint  state)

Helper method to get a string representation of a libnice ICE state.

Parameters
[in]stateThe libnice ICE state
Returns
A string representation of the libnice ICE state

◆ janus_get_min_nack_queue()

uint16_t janus_get_min_nack_queue ( void  )

Method to get the current min NACK value (i.e., the minimum time window of packets per handle to store for retransmissions)

Returns
The current min NACK value

◆ janus_get_no_media_timer()

uint janus_get_no_media_timer ( void  )

Method to get the current no-media event timer (see above)

Returns
The current no-media event timer

◆ janus_get_slowlink_threshold()

uint janus_get_slowlink_threshold ( void  )

Method to get the current slowlink-threshold value (see above)

Returns
The current slowlink-threshold value

◆ janus_get_twcc_period()

uint janus_get_twcc_period ( void  )

Method to get the current TWCC period (see above)

Returns
The current TWCC period

◆ janus_ice_add_remote_candidate()

void janus_ice_add_remote_candidate ( janus_ice_handle handle,
NiceCandidate *  c 
)

Method to queue a remote candidate for processing.

Parameters
[in]handleThe Janus ICE handle this method refers to
[in]cThe remote NiceCandidate to process

◆ janus_ice_candidates_to_sdp()

void janus_ice_candidates_to_sdp ( janus_ice_handle handle,
janus_sdp_mline mline,
guint  stream_id,
guint  component_id 
)

Method to add local candidates to a janus_sdp SDP object representation.

Parameters
[in]handleThe Janus ICE handle this method refers to
[in]mlineThe Janus SDP m-line object to add candidates to
[in]stream_idThe stream ID of the candidate to add to the SDP
[in]component_idThe component ID of the candidate to add to the SDP

◆ janus_ice_debugging_disable()

void janus_ice_debugging_disable ( void  )

Method to disable libnice debugging (the default)

◆ janus_ice_debugging_enable()

void janus_ice_debugging_enable ( void  )

◆ janus_ice_deinit()

void janus_ice_deinit ( void  )

ICE stuff de-initialization.

◆ janus_ice_dtls_handshake_done()

void janus_ice_dtls_handshake_done ( janus_ice_handle handle)

Callback to be notified when the DTLS handshake for a specific component has been completed.

This method also decides when to notify attached plugins about the availability of a reliable PeerConnection

Parameters
[in]handleThe Janus ICE handle this callback refers to

◆ janus_ice_enable_nat_1_1()

void janus_ice_enable_nat_1_1 ( gboolean  keep_private_host)

Helper method to force Janus to overwrite all host candidates with the public IP.

Parameters
[in]keep_private_hostWhether we should keep the original private host as a separate candidate, or replace it

◆ janus_ice_enforce_interface()

void janus_ice_enforce_interface ( const char *  ip)

Method to add an interface/IP to the enforce list for ICE (that is, only gather candidates from these and ignore the others)

Note
This method is especially useful to speed up the ICE gathering process on the server: in fact, if you know in advance which interface must be used (e.g., the main interface connected to the internet), adding it to the enforce list will prevent libnice from gathering candidates from other interfaces. If you're interested in excluding interfaces explicitly, instead, check janus_ice_ignore_interface.
Parameters
[in]ipInterface/IP to enforce (e.g., 192.168. or eth0)

◆ janus_ice_get_event_stats_period()

int janus_ice_get_event_stats_period ( void  )

Method to get the current event handler statistics period (see above)

Returns
The current event handler stats period

◆ janus_ice_get_static_event_loops()

int janus_ice_get_static_event_loops ( void  )

Method to return the number of static event loops, if enabled.

Returns
The number of static event loops, if configured, or 0 if the feature is disabled

◆ janus_ice_get_stun_port()

uint16_t janus_ice_get_stun_port ( void  )

Method to get the STUN server port.

Returns
The currently used STUN server port, if available, or 0 if not

◆ janus_ice_get_stun_server()

char* janus_ice_get_stun_server ( void  )

Method to get the STUN server IP address.

Returns
The currently used STUN server IP address, if available, or NULL if not

◆ janus_ice_get_turn_port()

uint16_t janus_ice_get_turn_port ( void  )

Method to get the TURN server port.

Returns
The currently used TURN server port, if available, or 0 if not

◆ janus_ice_get_turn_rest_api()

char* janus_ice_get_turn_rest_api ( void  )

Method to get the specified TURN REST API backend, if any.

Returns
The currently specified TURN REST API backend, if available, or NULL if not

◆ janus_ice_get_turn_server()

char* janus_ice_get_turn_server ( void  )

Method to get the TURN server IP address.

Returns
The currently used TURN server IP address, if available, or NULL if not

◆ janus_ice_handle_attach_plugin()

gint janus_ice_handle_attach_plugin ( void *  core_session,
janus_ice_handle handle,
janus_plugin plugin 
)

Method to attach a Janus ICE handle to a plugin.

This method is very important, as it allows plugins to send/receive media (RTP/RTCP) to/from a WebRTC peer.

Parameters
[in]core_sessionThe core/peer session this ICE handle belongs to
[in]handleThe Janus ICE handle
[in]pluginThe plugin the ICE handle needs to be attached to
Returns
0 in case of success, a negative integer otherwise

◆ janus_ice_handle_create()

janus_ice_handle* janus_ice_handle_create ( void *  core_session,
const char *  opaque_id,
const char *  token 
)

Method to create a new Janus ICE handle.

Parameters
[in]core_sessionThe core/peer session this ICE handle will belong to
[in]opaque_idThe opaque identifier provided by the creator, if any (optional)
[in]tokenThe auth token provided by the creator, if any (optional)
Returns
The created Janus ICE handle if successful, NULL otherwise

◆ janus_ice_handle_destroy()

gint janus_ice_handle_destroy ( void *  core_session,
janus_ice_handle handle 
)

Method to destroy a Janus ICE handle.

Parameters
[in]core_sessionThe core/peer session this ICE handle belongs to
[in]handleThe Janus ICE handle to destroy
Returns
0 in case of success, a negative integer otherwise

◆ janus_ice_ignore_interface()

void janus_ice_ignore_interface ( const char *  ip)

Method to add an interface/IP to the ignore list for ICE (that is, don't gather candidates)

Note
This method is especially useful to speed up the ICE gathering process on the server: in fact, if you know in advance an interface is not going to be used (e.g., one of those created by VMware), adding it to the ignore list will prevent libnice from gathering a candidate for it. Unlike the enforce list, the ignore list also accepts IP addresses, partial or complete. If you're interested in only using specific interfaces, instead, check janus_ice_enforce_interface.
Parameters
[in]ipInterface/IP to ignore (e.g., 192.168. or eth1)

◆ janus_ice_incoming_data()

void janus_ice_incoming_data ( janus_ice_handle handle,
char *  label,
char *  protocol,
gboolean  textdata,
char *  buffer,
int  length 
)

Plugin SCTP/DataChannel callback, called by the SCTP stack when when there's data for a plugin.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]labelThe label of the data channel the message is from
[in]protocolThe protocol of the data channel to use
[in]textdataWhether the buffer is text (domstring) or binary data
[in]bufferThe message data (buffer)
[in]lengthThe buffer length

◆ janus_ice_init()

void janus_ice_init ( gboolean  ice_lite,
gboolean  ice_tcp,
gboolean  full_trickle,
gboolean  ignore_mdns,
gboolean  ipv6,
uint16_t  rtp_min_port,
uint16_t  rtp_max_port 
)

ICE stuff initialization.

Parameters
[in]ice_liteWhether the ICE Lite mode should be enabled or not
[in]ice_tcpWhether ICE-TCP support should be enabled or not (only libnice >= 0.1.8, currently broken)
[in]full_trickleWhether full-trickle must be used (instead of half-trickle)
[in]ignore_mdnsWhether mDNS candidates should be ignored, instead of resolved
[in]ipv6Whether IPv6 candidates must be negotiated or not
[in]rtp_min_portMinimum port to use for RTP/RTCP, if a range is to be used
[in]rtp_max_portMaximum port to use for RTP/RTCP, if a range is to be used
Note
The RTP/RTCP port range configuration may be just a placeholder: for instance, libnice supports this since 0.1.0, but the 0.1.3 on Fedora fails when linking with an undefined reference to nice_agent_set_port_range so this is checked by the install.sh script in advance.

◆ janus_ice_is_enforced()

gboolean janus_ice_is_enforced ( const char *  ip)

Method to check whether an interface is currently in the enforce list for ICE (that is, won't have candidates)

Parameters
[in]ipInterface/IP to check (e.g., 192.168.244.1 or eth1)
Returns
true if the interface/IP is in the enforce list, false otherwise

◆ janus_ice_is_full_trickle_enabled()

gboolean janus_ice_is_full_trickle_enabled ( void  )

Method to check whether full-trickle support is enabled or not.

Returns
true if full-trickle support is enabled, false otherwise

◆ janus_ice_is_ice_debugging_enabled()

gboolean janus_ice_is_ice_debugging_enabled ( void  )

Method to check whether libnice debugging has been enabled (http://nice.freedesktop.org/libnice/libnice-Debug-messages.html)

Returns
True if libnice debugging is enabled, FALSE otherwise

◆ janus_ice_is_ice_lite_enabled()

gboolean janus_ice_is_ice_lite_enabled ( void  )

Method to check whether ICE Lite mode is enabled or not (still WIP)

Returns
true if ICE-TCP support is enabled/supported, false otherwise

◆ janus_ice_is_ice_tcp_enabled()

gboolean janus_ice_is_ice_tcp_enabled ( void  )

Method to check whether ICE-TCP support is enabled/supported or not (still WIP)

Returns
true if ICE-TCP support is enabled/supported, false otherwise

◆ janus_ice_is_ignored()

gboolean janus_ice_is_ignored ( const char *  ip)

Method to check whether an interface/IP is currently in the ignore list for ICE (that is, won't have candidates)

Parameters
[in]ipInterface/IP to check (e.g., 192.168.244.1 or eth1)
Returns
true if the interface/IP is in the ignore list, false otherwise

◆ janus_ice_is_ipv6_enabled()

gboolean janus_ice_is_ipv6_enabled ( void  )

Method to check whether IPv6 candidates are enabled/supported or not.

Returns
true if IPv6 candidates are enabled/supported, false otherwise

◆ janus_ice_is_keepalive_conncheck_enabled()

gboolean janus_ice_is_keepalive_conncheck_enabled ( void  )

Method to check whether connectivity checks will be used as keepalives.

Returns
true if enabled, false (default) otherwise

◆ janus_ice_is_mdns_enabled()

gboolean janus_ice_is_mdns_enabled ( void  )

Method to check whether mDNS resolution is enabled or not.

Returns
true if mDNS resolution is enabled, false otherwise

◆ janus_ice_notify_data_ready()

void janus_ice_notify_data_ready ( janus_ice_handle handle)

Plugin SCTP/DataChannel callback, called by the SCTP stack when data can be written.

Parameters
[in]handleThe Janus ICE handle associated with the peer

◆ janus_ice_notify_hangup()

void janus_ice_notify_hangup ( janus_ice_handle handle,
const char *  reason 
)

Quick helper method to notify a WebRTC hangup through the Janus API.

Parameters
handleThe janus_ice_handle instance this event refers to
reasonA description of why this happened

◆ janus_ice_peerconnection_destroy()

void janus_ice_peerconnection_destroy ( janus_ice_peerconnection pc)

Method to only free resources related to a specific Webrtc PeerConnection allocated by a Janus ICE handle.

Parameters
[in]componentThe Janus ICE component instance to free

◆ janus_ice_peerconnection_medium_create()

janus_ice_peerconnection_medium* janus_ice_peerconnection_medium_create ( janus_ice_handle handle,
janus_media_type  type 
)

Method to quickly create a medium to be added to a handle PeerConnection.

Note
This will autogenerate SSRCs, if needed
Parameters
[in]handleThe Janus handle instance to add the medium to
[in]typeThe medium type
Returns
A pointer to the new medium, if successful, or NULL otherwise

◆ janus_ice_relay_data()

void janus_ice_relay_data ( janus_ice_handle handle,
janus_plugin_data packet 
)

Core SCTP/DataChannel callback, called when a plugin has data to send to a peer.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]packetThe message to send

◆ janus_ice_relay_rtcp()

void janus_ice_relay_rtcp ( janus_ice_handle handle,
janus_plugin_rtcp packet 
)

Core RTCP callback, called when a plugin has an RTCP message to send to a peer.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]packetThe RTCP message to send

◆ janus_ice_relay_rtp()

void janus_ice_relay_rtp ( janus_ice_handle handle,
janus_plugin_rtp packet 
)

Core RTP callback, called when a plugin has an RTP packet to send to a peer.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]packetThe RTP packet to send

◆ janus_ice_relay_sctp()

void janus_ice_relay_sctp ( janus_ice_handle handle,
char *  buffer,
int  length 
)

Core SCTP/DataChannel callback, called by the SCTP stack when when there's data to send.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]bufferThe message data (buffer)
[in]lengthThe buffer length

◆ janus_ice_resend_trickles()

void janus_ice_resend_trickles ( janus_ice_handle handle)

Method to resend all the existing candidates via trickle (e.g., after an ICE restart)

Parameters
[in]handleThe Janus ICE handle this method refers to

◆ janus_ice_restart()

void janus_ice_restart ( janus_ice_handle handle)

Method to restart ICE and the connectivity checks.

Parameters
[in]handleThe Janus ICE handle this method refers to

◆ janus_ice_send_pli()

void janus_ice_send_pli ( janus_ice_handle handle)

Helper core callback, called when a plugin wants to send a RTCP PLI to a peer.

Parameters
[in]handleThe Janus ICE handle associated with the peer

◆ janus_ice_send_pli_stream()

void janus_ice_send_pli_stream ( janus_ice_handle handle,
int  mindex 
)

Helper core callback, called when a plugin wants to send a RTCP PLI to a single video stream of a peer.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]mindexIndex of the stream to send the PLI to (relative to the SDP)

◆ janus_ice_send_remb()

void janus_ice_send_remb ( janus_ice_handle handle,
uint32_t  bitrate 
)

Helper core callback, called when a plugin wants to send a RTCP REMB to a peer.

Parameters
[in]handleThe Janus ICE handle associated with the peer
[in]bitrateThe bitrate value to put in the REMB message

◆ janus_ice_set_event_stats_period()

void janus_ice_set_event_stats_period ( int  period)

Method to modify the event handler statistics period (i.e., the number of seconds that should pass before Janus notifies event handlers about media statistics for a PeerConnection)

Parameters
[in]periodThe new period value, in seconds

◆ janus_ice_set_keepalive_conncheck_enabled()

void janus_ice_set_keepalive_conncheck_enabled ( gboolean  enabled)

Method to enable/disable connectivity checks as keepalives for PeerConnections.

Note
The main rationale behind this setting is provided in the libnice documentation: https://libnice.freedesktop.org/libnice/NiceAgent.html#NiceAgent&ndash;keepalive-conncheck
Parameters
[in]enabledWhether the functionality should be enabled or disabled

◆ janus_ice_set_static_event_loops()

void janus_ice_set_static_event_loops ( int  loops)

Method to configure the static event loops mechanism at startup.

Note
Check the event_loops property in the janus.jcfg configuration for an explanation of this feature, and the possible impact on Janus and users
Parameters
[in]loopsThe number of static event loops to start (0 to disable the feature)

◆ janus_ice_set_stun_server()

int janus_ice_set_stun_server ( gchar *  stun_server,
uint16_t  stun_port 
)

Method to force Janus to use a STUN server when gathering candidates.

Parameters
[in]stun_serverSTUN server address to use
[in]stun_portSTUN port to use
Returns
0 in case of success, a negative integer on errors

◆ janus_ice_set_turn_rest_api()

int janus_ice_set_turn_rest_api ( gchar *  api_server,
gchar *  api_key,
gchar *  api_method,
uint  api_timeout 
)

Method to force Janus to contact a TURN REST API server to get a TURN service to use when gathering candidates. The TURN REST API takes precedence over any static credential passed via janus_ice_set_turn_server.

Note
Requires libcurl to be available, and a working TURN REST API backend (see turnrest.h)
Parameters
[in]api_serverTURN REST API backend (NULL to disable the API)
[in]api_keyAPI key to use, if required
[in]api_methodHTTP method to use (POST by default)
[in]api_timeouttotal timeout for HTTP method in seconds
Returns
0 in case of success, a negative integer on errors

◆ janus_ice_set_turn_server()

int janus_ice_set_turn_server ( gchar *  turn_server,
uint16_t  turn_port,
gchar *  turn_type,
gchar *  turn_user,
gchar *  turn_pwd 
)

Method to force Janus to use a TURN server when gathering candidates.

Parameters
[in]turn_serverTURN server address to use
[in]turn_portTURN port to use
[in]turn_typeRelay type (udp, tcp or tls)
[in]turn_userTURN username, if needed
[in]turn_pwdTURN password, if needed
Returns
0 in case of success, a negative integer on errors

◆ janus_ice_setup_local()

int janus_ice_setup_local ( janus_ice_handle handle,
gboolean  offer,
gboolean  trickle 
)

Method to locally set up the ICE candidates (initialization and gathering)

Parameters
[in]handleThe Janus ICE handle this method refers to
[in]offerWhether this is for an OFFER or an ANSWER
[in]trickleWhether ICE trickling is supported or not
Returns
0 in case of success, a negative integer otherwise

◆ janus_ice_setup_remote_candidates()

void janus_ice_setup_remote_candidates ( janus_ice_handle handle,
guint  stream_id,
guint  component_id 
)

Method to handle remote candidates and start the connectivity checks.

Parameters
[in]handleThe Janus ICE handle this method refers to
[in]stream_idThe stream ID of the candidate to add to the SDP
[in]component_idThe component ID of the candidate to add to the SDP

◆ janus_ice_stop_static_event_loops()

void janus_ice_stop_static_event_loops ( void  )

Method to stop all the static event loops, if enabled.

Note
This will wait for the related threads to exit, and so may delay the shutdown process

◆ janus_ice_test_stun_server()

int janus_ice_test_stun_server ( janus_network_address addr,
uint16_t  port,
uint16_t  local_port,
janus_network_address public_addr,
uint16_t *  public_port 
)

Method to check whether a STUN server is reachable.

Parameters
[in]addrAddress of the STUN server as a janus_network_address instance
[in]portPort of the STUN server
[in]local_portLocal port to bind to (0 means random choice)
[out]public_addrPublic address returned by the STUN server as a janus_network_address instance
[out]public_portPublic port returned by the STUN server
Returns
0 in case of success, a negative integer on errors

◆ janus_ice_trickle_destroy()

void janus_ice_trickle_destroy ( janus_ice_trickle trickle)

Helper method to destroy a janus_ice_trickle instance.

Parameters
[in]trickleThe janus_ice_trickle instance to destroy

◆ janus_ice_trickle_new()

janus_ice_trickle* janus_ice_trickle_new ( const char *  transaction,
json_t candidate 
)

Helper method to allocate a janus_ice_trickle instance.

Parameters
[in]transactionThe Janus API ID of the original trickle request
[in]candidateThe trickle candidate, as a Jansson object
Returns
a pointer to the new instance, if successful, NULL otherwise

◆ janus_ice_trickle_parse()

gint janus_ice_trickle_parse ( janus_ice_handle handle,
json_t candidate,
const char **  error 
)

Helper method to parse trickle candidates.

Parameters
[in]handleThe Janus ICE handle this candidate belongs to
[in]candidateThe trickle candidate to parse, as a Jansson object
[in,out]errorError string describing the failure, if any
Returns
0 in case of success, any code from apierror.h in case of failure

◆ janus_ice_webrtc_hangup()

void janus_ice_webrtc_hangup ( janus_ice_handle handle,
const char *  reason 
)

Method to only hangup (e.g., DTLS alert) the WebRTC PeerConnection allocated by a Janus ICE handle.

Parameters
[in]handleThe Janus ICE handle instance managing the WebRTC PeerConnection to hangup
[in]reasonA description of why this happened

◆ janus_is_nack_optimizations_enabled()

gboolean janus_is_nack_optimizations_enabled ( void  )

Method to check whether NACK optimizations on outgoing keyframes are enabled or not.

Returns
optimize if optimizations are enabled, false otherwise

◆ janus_is_opaqueid_in_api_enabled()

gboolean janus_is_opaqueid_in_api_enabled ( void  )

Method to check whether opaque ID have to be added to Janus API responses/events.

Returns
TRUE if they need to be present, FALSE otherwise

◆ janus_plugin_session_is_alive()

gboolean janus_plugin_session_is_alive ( janus_plugin_session plugin_session)

Quick helper method to check if a plugin session associated with a Janus handle is still valid.

Parameters
plugin_sessionThe janus_plugin_session instance to validate
Returns
true if the plugin session is valid, false otherwise

◆ janus_seq_list_free()

void janus_seq_list_free ( janus_seq_info **  head)

◆ janus_set_dscp()

void janus_set_dscp ( int  dscp)

Method to modify the DSCP value to set, which is disabled by default.

Parameters
[in]dscpThe new DSCP value (0 to disable)

◆ janus_set_min_nack_queue()

void janus_set_min_nack_queue ( uint16_t  mnq)

Method to modify the min NACK value (i.e., the minimum time window of packets per handle to store for retransmissions)

Parameters
[in]mnqThe new min NACK value

◆ janus_set_nack_optimizations_enabled()

void janus_set_nack_optimizations_enabled ( gboolean  optimize)

Method to enable/disable the NACK optimizations on outgoing keyframes: when enabled, the NACK buffer for a PeerConnection is cleaned any time Janus sends a keyframe, as any missing packet won't be needed since the keyframe will allow the media recipient to still restore a complete image anyway. Since this optimization seems to cause some issues in some edge cases, it's disabled by default.

Parameters
[in]optimizeWhether the optimization should be enabled or disabled

◆ janus_set_no_media_timer()

void janus_set_no_media_timer ( uint  timer)

Method to modify the no-media event timer (i.e., the number of seconds where no media arrives before Janus notifies this)

Parameters
[in]timerThe new timer value, in seconds

◆ janus_set_slowlink_threshold()

void janus_set_slowlink_threshold ( uint  packets)

Method to modify the slowlink-threshold property (i.e., the number of lost packets per seconds that should trigger a slow-link event)

Parameters
[in]packetsThe new value, in lost packets per seconds

◆ janus_set_twcc_period()

void janus_set_twcc_period ( uint  period)

Method to modify the TWCC feedback period (i.e., how often TWCC feedback is sent back to media senders)

Parameters
[in]periodThe new period value, in milliseconds