NiceAgent

typedef struct _NiceAgent NiceAgent;

The NiceAgent is the main GObject of the libnice library and represents the ICE agent.

enum NiceComponentState

typedef enum {
  NICE_COMPONENT_STATE_DISCONNECTED,
  NICE_COMPONENT_STATE_GATHERING,
  NICE_COMPONENT_STATE_CONNECTING,
  NICE_COMPONENT_STATE_CONNECTED,
  NICE_COMPONENT_STATE_READY,
  NICE_COMPONENT_STATE_FAILED,
  NICE_COMPONENT_STATE_LAST
} NiceComponentState;

An enum representing the state of a component.

See also: "component-state-changed"

enum NiceComponentType

typedef enum {
  NICE_COMPONENT_TYPE_RTP = 1,
  NICE_COMPONENT_TYPE_RTCP = 2
} NiceComponentType;

Convenience enum representing the type of a component for use as the component_id for RTP/RTCP usages.

1

nice_agent_send (agent, stream_id, NICE_COMPONENT_TYPE_RTP, len, buf);

enum NiceProxyType

typedef enum {
  NICE_PROXY_TYPE_NONE = 0,
  NICE_PROXY_TYPE_SOCKS5,
  NICE_PROXY_TYPE_HTTP,
  NICE_PROXY_TYPE_LAST = NICE_PROXY_TYPE_HTTP,
} NiceProxyType;

An enum to specify which proxy type to use for relaying. Note that the proxies will only be used with TCP TURN relaying.

See also: "proxy-type"

Since 0.0.4

enum NiceCompatibility

typedef enum {
  NICE_COMPATIBILITY_RFC5245 = 0,
  NICE_COMPATIBILITY_GOOGLE,
  NICE_COMPATIBILITY_MSN,
  NICE_COMPATIBILITY_WLM2009,
  NICE_COMPATIBILITY_OC2007,
  NICE_COMPATIBILITY_OC2007R2,
  NICE_COMPATIBILITY_DRAFT19 = NICE_COMPATIBILITY_RFC5245,
  NICE_COMPATIBILITY_LAST = NICE_COMPATIBILITY_OC2007R2,
} NiceCompatibility;

An enum to specify which compatible specifications the NiceAgent should use. Use with nice_agent_new()

NiceAgentRecvFunc ()

void                (*NiceAgentRecvFunc)                (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         guint len,
                                                         gchar *buf,
                                                         gpointer user_data);

Callback function when data is received on a component

NiceInputMessage

typedef struct {
  GInputVector *buffers;
  gint n_buffers;  /* may be -1 to indicate @buffers is NULL-terminated */
  NiceAddress *from;  /* return location for address of message sender */
  gsize length;  /* sum of the lengths of @buffers */
} NiceInputMessage;

Represents a single message received off the network. For reliable connections, this is essentially just an array of buffers (specifically, from can be ignored). for non-reliable connections, it represents a single packet as received from the OS.

n_buffers may be -1 to indicate that buffers is terminated by a GInputVector with a NULL buffer pointer.

By providing arrays of NiceInputMessages to functions like nice_agent_recv_messages(), multiple messages may be received with a single call, which is more efficient than making multiple calls in a loop. In this manner, nice_agent_recv_messages() is analogous to recvmmsg(); and NiceInputMessage to struct mmsghdr.

Since 0.1.5

NiceOutputMessage

typedef struct {
  GOutputVector *buffers;
  gint n_buffers;
} NiceOutputMessage;

Represents a single message to transmit on the network. For reliable connections, this is essentially just an array of buffer. for non-reliable connections, it represents a single packet to send to the OS.

n_buffers may be -1 to indicate that buffers is terminated by a GOutputVector with a NULL buffer pointer.

By providing arrays of NiceOutputMessages to functions like nice_agent_send_messages_nonblocking(), multiple messages may be transmitted with a single call, which is more efficient than making multiple calls in a loop. In this manner, nice_agent_send_messages_nonblocking() is analogous to sendmmsg(); and NiceOutputMessage to struct mmsghdr.

Since 0.1.5

NICE_AGENT_MAX_REMOTE_CANDIDATES

#define NICE_AGENT_MAX_REMOTE_CANDIDATES    25

A hard limit for the number of remote candidates. This limit is enforced to protect against malevolent remote clients.

nice_agent_new ()

NiceAgent *         nice_agent_new                      (GMainContext *ctx,
                                                         NiceCompatibility compat);

Create a new NiceAgent. The returned object must be freed with g_object_unref()

nice_agent_new_reliable ()

NiceAgent *         nice_agent_new_reliable             (GMainContext *ctx,
                                                         NiceCompatibility compat);

Create a new NiceAgent in reliable mode, which uses PseudoTcpSocket to assure reliability of the messages. The returned object must be freed with g_object_unref()

See also: "reliable-transport-writable"

Since 0.0.11

nice_agent_add_local_address ()

gboolean            nice_agent_add_local_address        (NiceAgent *agent,
                                                         NiceAddress *addr);

Add a local address from which to derive local host candidates for candidate gathering.

Since 0.0.5, if this method is not called, libnice will automatically discover the local addresses available

See also: nice_agent_gather_candidates()

nice_agent_set_port_range ()

void                nice_agent_set_port_range           (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         guint min_port,
                                                         guint max_port);

Sets a preferred port range for allocating host candidates.

If a local host candidate cannot be created on that port range, then the nice_agent_gather_candidates() call will fail.

This MUST be called before nice_agent_gather_candidates()

nice_agent_add_stream ()

guint               nice_agent_add_stream               (NiceAgent *agent,
                                                         guint n_components);

Adds a data stream to agent containing n_components components. The returned stream ID is guaranteed to be positive on success.

nice_agent_remove_stream ()

void                nice_agent_remove_stream            (NiceAgent *agent,
                                                         guint stream_id);

Remove and free a previously created data stream from agent

nice_agent_set_relay_info ()

gboolean            nice_agent_set_relay_info           (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         const gchar *server_ip,
                                                         guint server_port,
                                                         const gchar *username,
                                                         const gchar *password,
                                                         NiceRelayType type);

Sets the settings for using a relay server during the candidate discovery. This may be called multiple times to add multiple relay servers to the discovery process; one TCP and one UDP, for example.

nice_agent_forget_relays ()

gboolean            nice_agent_forget_relays            (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id);

Forget all the relay servers previously added using nice_agent_set_relay_info(). Currently connected streams will keep using the relay as long as they have not been restarted and haven't succesfully negotiated a different path.

Since 0.1.6

nice_agent_gather_candidates ()

gboolean            nice_agent_gather_candidates        (NiceAgent *agent,
                                                         guint stream_id);

Allocate and start listening on local candidate ports and start the remote candidate gathering process. Once done, "candidate-gathering-done" is called for the stream. As soon as this function is called, "new-candidate" signals may be emitted, even before this function returns.

nice_agent_get_local_candidates() will only return non-empty results after calling this function.

See also: nice_agent_add_local_address()

See also: nice_agent_set_port_range()

nice_agent_set_remote_credentials ()

gboolean            nice_agent_set_remote_credentials   (NiceAgent *agent,
                                                         guint stream_id,
                                                         const gchar *ufrag,
                                                         const gchar *pwd);

Sets the remote credentials for stream stream_id.

nice_agent_get_local_credentials ()

gboolean            nice_agent_get_local_credentials    (NiceAgent *agent,
                                                         guint stream_id,
                                                         gchar **ufrag,
                                                         gchar **pwd);

Gets the local credentials for stream stream_id. This may be called any time after creating a stream using nice_agent_add_stream().

An error will be returned if this is called for a non-existent stream, or if either of ufrag or pwd are NULL.

nice_agent_set_remote_candidates ()

int                 nice_agent_set_remote_candidates    (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         const GSList *candidates);

Sets, adds or updates the remote candidates for a component of a stream.

nice_agent_get_remote_candidates ()

GSList *            nice_agent_get_remote_candidates    (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id);

Get a list of the remote candidates set on a stream's component

nice_agent_get_local_candidates ()

GSList *            nice_agent_get_local_candidates     (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id);

Retreive from the agent the list of all local candidates for a stream's component

nice_agent_get_selected_pair ()

gboolean            nice_agent_get_selected_pair        (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         NiceCandidate **local,
                                                         NiceCandidate **remote);

Retreive the selected candidate pair for media transmission for a given stream's component.

nice_agent_send ()

gint                nice_agent_send                     (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         guint len,
                                                         const gchar *buf);

Sends a data payload over a stream's component.

nice_agent_send_messages_nonblocking ()

gint                nice_agent_send_messages_nonblocking
                                                        (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         const NiceOutputMessage *messages,
                                                         guint n_messages,
                                                         GCancellable *cancellable,
                                                         GError **error);

Sends multiple messages on the socket identified by the given stream/component pair. Transmission is non-blocking, so a G_IO_ERROR_WOULD_BLOCK error may be returned if the send buffer is full.

As with nice_agent_send(), the given component must be in NICE_COMPONENT_STATE_READY or, as a special case, in any state if it was previously ready and was then restarted.

On success, the number of messages written to the socket will be returned, which may be less than n_messages if transmission would have blocked part-way through. Zero will be returned if n_messages is zero, or if transmission would have blocked on the first message.

In reliable mode, it is instead recommended to use nice_agent_send(). The return value can be less than n_messages or 0 even if it is still possible to send a partial message. In this case, "nice-agent-writable" will never be triggered, so the application would have to use nice_agent_sent() to fill the buffer or have to retry sending at a later point.

On failure, -1 will be returned and error will be set. If the NiceAgent is reliable and the socket is not yet connected, G_IO_ERROR_BROKEN_PIPE will be returned; if the write buffer is full, G_IO_ERROR_WOULD_BLOCK will be returned. In both cases, wait for the "reliable-transport-writable" signal before trying again. If the given stream_id or component_id are invalid or not yet connected, G_IO_ERROR_BROKEN_PIPE will be returned. G_IO_ERROR_FAILED will be returned for other errors.

Since 0.1.5

nice_agent_recv ()

gssize              nice_agent_recv                     (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         guint8 *buf,
                                                         gsize buf_len,
                                                         GCancellable *cancellable,
                                                         GError **error);

A single-message version of nice_agent_recv_messages().

Since 0.1.5

nice_agent_recv_messages ()

gint                nice_agent_recv_messages            (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         NiceInputMessage *messages,
                                                         guint n_messages,
                                                         GCancellable *cancellable,
                                                         GError **error);

Block on receiving data from the given stream/component combination on agent, returning only once exactly n_messages messages have been received and written into messages, the stream is closed by the other end or by calling nice_agent_remove_stream(), or cancellable is cancelled.

In the non-error case, in reliable mode, this will block until all buffers in all n_messages have been filled with received data (i.e. messages is treated as a large, flat array of buffers). In non-reliable mode, it will block until n_messages messages have been received, each of which does not have to fill all the buffers in its NiceInputMessage. In the non-reliable case, each NiceInputMessage must have enough buffers to contain an entire message (65536 bytes), or any excess data may be silently dropped.

For each received message, "length" will be set to the number of valid bytes stored in the message’s buffers. The bytes are stored sequentially in the buffers; there are no gaps apart from at the end of the buffer array (in non-reliable mode). If non-NULL on input, "from" will have the address of the sending peer stored in it. The base addresses, sizes, and number of buffers in each message will not be modified in any case.

This must not be used in combination with nice_agent_attach_recv() on the same stream/component pair.

If the stream/component pair doesn’t exist, or if a suitable candidate socket hasn’t yet been selected for it, a G_IO_ERROR_BROKEN_PIPE error will be returned. A G_IO_ERROR_CANCELLED error will be returned if the operation was cancelled. G_IO_ERROR_FAILED will be returned for other errors.

Since 0.1.5

nice_agent_recv_nonblocking ()

gssize              nice_agent_recv_nonblocking         (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         guint8 *buf,
                                                         gsize buf_len,
                                                         GCancellable *cancellable,
                                                         GError **error);

A single-message version of nice_agent_recv_messages_nonblocking().

Since 0.1.5

nice_agent_recv_messages_nonblocking ()

gint                nice_agent_recv_messages_nonblocking
                                                        (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         NiceInputMessage *messages,
                                                         guint n_messages,
                                                         GCancellable *cancellable,
                                                         GError **error);

Try to receive data from the given stream/component combination on agent, without blocking. If receiving data would block, -1 is returned and G_IO_ERROR_WOULD_BLOCK is set in error. If any other error occurs, -1 is returned and error is set accordingly. Otherwise, 0 is returned if (and only if) n_messages is 0. In all other cases, the number of valid messages stored in messages is returned, and will be greater than 0.

This function behaves similarly to nice_agent_recv_messages(), except that it will not block on filling (in reliable mode) or receiving (in non-reliable mode) exactly n_messages messages. In reliable mode, it will receive bytes into messages until it would block; in non-reliable mode, it will receive messages until it would block.

As this function is non-blocking, cancellable is included only for parity with nice_agent_recv_messages(). If cancellable is cancelled before this function is called, a G_IO_ERROR_CANCELLED error will be returned immediately.

This must not be used in combination with nice_agent_attach_recv() on the same stream/component pair.

Since 0.1.5

nice_agent_attach_recv ()

gboolean            nice_agent_attach_recv              (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         GMainContext *ctx,
                                                         NiceAgentRecvFunc func,
                                                         gpointer data);

Attaches the stream's component's sockets to the Glib Mainloop Context in order to be notified whenever data becomes available for a component.

This must not be used in combination with nice_agent_recv_messages() (or NiceIOStream or NiceInputStream) on the same stream/component pair.

Calling nice_agent_attach_recv() with a NULL func will detach any existing callback and cause reception to be paused for the given stream/component pair. You must iterate the previously specified GMainContext sufficiently to ensure all pending I/O callbacks have been received before calling this function to unset func, otherwise data loss of received packets may occur.

nice_agent_set_selected_pair ()

gboolean            nice_agent_set_selected_pair        (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         const gchar *lfoundation,
                                                         const gchar *rfoundation);

Sets the selected candidate pair for media transmission for a given stream's component. Calling this function will disable all further ICE processing (connection check, state machine updates, etc). Note that keepalives will continue to be sent.

nice_agent_set_selected_remote_candidate ()

gboolean            nice_agent_set_selected_remote_candidate
                                                        (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id,
                                                         NiceCandidate *candidate);

Sets the selected remote candidate for media transmission for a given stream's component. This is used to force the selection of a specific remote candidate even when connectivity checks are failing (e.g. non-ICE compatible candidates). Calling this function will disable all further ICE processing (connection check, state machine updates, etc). Note that keepalives will continue to be sent.

nice_agent_set_stream_tos ()

void                nice_agent_set_stream_tos           (NiceAgent *agent,
                                                         guint stream_id,
                                                         gint tos);

Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options

Since 0.0.9

nice_agent_set_software ()

void                nice_agent_set_software             (NiceAgent *agent,
                                                         const gchar *software);

This function will set the value of the SOFTWARE attribute to be added to STUN requests, responses and error responses sent during connectivity checks.

The SOFTWARE attribute will only be added in the NICE_COMPATIBILITY_RFC5245 and NICE_COMPATIBILITY_WLM2009 compatibility modes.

Since 0.0.10

nice_agent_restart ()

gboolean            nice_agent_restart                  (NiceAgent *agent);

Restarts the session as defined in ICE draft 19. This function needs to be called both when initiating (ICE spec section 9.1.1.1. "ICE Restarts"), as well as when reacting (spec section 9.2.1.1. "Detecting ICE Restart") to a restart.

nice_agent_restart_stream ()

gboolean            nice_agent_restart_stream           (NiceAgent *agent,
                                                         guint stream_id);

Restarts a single stream as defined in RFC 5245. This function needs to be called both when initiating (ICE spec section 9.1.1.1. "ICE Restarts"), as well as when reacting (spec section 9.2.1.1. "Detecting ICE Restart") to a restart.

Unlike nice_agent_restart(), this applies to a single stream. It also does not generate a new tie breaker.

Since 0.1.6

nice_agent_set_stream_name ()

gboolean            nice_agent_set_stream_name          (NiceAgent *agent,
                                                         guint stream_id,
                                                         const gchar *name);

This function will assign a unique name to a stream. This is only useful when parsing and generating an SDP of the candidates.

See also: nice_agent_generate_local_sdp()

See also: nice_agent_parse_remote_sdp()

See also: nice_agent_get_stream_name()

Since 0.1.4

nice_agent_get_stream_name ()

const gchar *       nice_agent_get_stream_name          (NiceAgent *agent,
                                                         guint stream_id);

This function will return the name assigned to a stream.

See also: nice_agent_set_stream_name()

Since 0.1.4

nice_agent_get_default_local_candidate ()

NiceCandidate *     nice_agent_get_default_local_candidate
                                                        (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id);

This helper function will return the recommended default candidate to be used for non-ICE compatible clients. This will usually be the candidate with the lowest priority, since it will be the longest path but the one with the most chances of success.

nice_agent_generate_local_sdp ()

gchar *             nice_agent_generate_local_sdp       (NiceAgent *agent);

Generate an SDP string containing the local candidates and credentials for all streams and components in the agent.

See also: nice_agent_set_stream_name()

See also: nice_agent_parse_remote_sdp()

See also: nice_agent_generate_local_stream_sdp()

See also: nice_agent_generate_local_candidate_sdp()

See also: nice_agent_get_default_local_candidate()

Since 0.1.4

nice_agent_generate_local_stream_sdp ()

gchar *             nice_agent_generate_local_stream_sdp
                                                        (NiceAgent *agent,
                                                         guint stream_id,
                                                         gboolean include_non_ice);

Generate an SDP string containing the local candidates and credentials for a stream.

See also: nice_agent_set_stream_name()

See also: nice_agent_parse_remote_stream_sdp()

See also: nice_agent_generate_local_sdp()

See also: nice_agent_generate_local_candidate_sdp()

See also: nice_agent_get_default_local_candidate()

Since 0.1.4

nice_agent_generate_local_candidate_sdp ()

gchar *             nice_agent_generate_local_candidate_sdp
                                                        (NiceAgent *agent,
                                                         NiceCandidate *candidate);

Generate an SDP string representing a local candidate.

See also: nice_agent_parse_remote_candidate_sdp()

See also: nice_agent_generate_local_sdp()

See also: nice_agent_generate_local_stream_sdp()

Since 0.1.4

nice_agent_parse_remote_sdp ()

int                 nice_agent_parse_remote_sdp         (NiceAgent *agent,
                                                         const gchar *sdp);

Parse an SDP string and extracts candidates and credentials from it and sets them on the agent.

See also: nice_agent_set_stream_name()

See also: nice_agent_generate_local_sdp()

See also: nice_agent_parse_remote_stream_sdp()

See also: nice_agent_parse_remote_candidate_sdp()

Since 0.1.4

nice_agent_parse_remote_stream_sdp ()

GSList *            nice_agent_parse_remote_stream_sdp  (NiceAgent *agent,
                                                         guint stream_id,
                                                         const gchar *sdp,
                                                         gchar **ufrag,
                                                         gchar **pwd);

Parse an SDP string representing a single stream and extracts candidates and credentials from it.

See also: nice_agent_generate_local_stream_sdp()

See also: nice_agent_parse_remote_sdp()

See also: nice_agent_parse_remote_candidate_sdp()

Since 0.1.4

nice_agent_parse_remote_candidate_sdp ()

NiceCandidate *     nice_agent_parse_remote_candidate_sdp
                                                        (NiceAgent *agent,
                                                         guint stream_id,
                                                         const gchar *sdp);

Parse an SDP string and extracts the candidate from it.

See also: nice_agent_generate_local_candidate_sdp()

See also: nice_agent_parse_remote_sdp()

See also: nice_agent_parse_remote_stream_sdp()

Since 0.1.4

nice_agent_get_io_stream ()

GIOStream *         nice_agent_get_io_stream            (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id);

Gets a GIOStream wrapper around the given stream and component in agent. The I/O stream will be valid for as long as stream_id is valid. The GInputStream and GOutputStream implement GPollableInputStream and GPollableOutputStream.

This function may only be called on reliable NiceAgents. It is a programming error to try and create an I/O stream wrapper for an unreliable stream.

Since 0.1.5

nice_agent_get_selected_socket ()

GSocket *           nice_agent_get_selected_socket      (NiceAgent *agent,
                                                         guint stream_id,
                                                         guint component_id);

Retreive the local socket associated with the selected candidate pair for media transmission for a given stream's component.

This is useful for adding ICE support to legacy applications that already have a protocol that maintains a connection. If the socket is duplicated before unrefing the agent, the application can take over and continue to use it. New applications are encouraged to use the built in libnice stream handling instead and let libnice handle the connection maintenance.

Users of this method are encouraged to not use a TURN relay or any kind of proxy, as in this case, the socket will not be available to the application because the packets are encapsulated.

Since 0.1.5

nice_component_state_to_string ()

const gchar *       nice_component_state_to_string      (NiceComponentState state);

Returns a string representation of the state, generally to use in debug messages.

Since 0.1.6

The "compatibility" property

  "compatibility"            guint                 : Read / Write / Construct Only

The Nice agent can work in various compatibility modes depending on what the application/peer needs.

See also: NiceCompatibility

Allowed values: <= 5

Default value: 0

The "controlling-mode" property

  "controlling-mode"         gboolean              : Read / Write

Whether the agent is in controlling mode.

Default value: FALSE

The "full-mode" property

  "full-mode"                gboolean              : Read / Write / Construct Only

Whether agent runs in ICE full mode.

Default value: TRUE

The "main-context" property

  "main-context"             gpointer              : Read / Write / Construct Only

A GLib main context is needed for all timeouts used by libnice. This is a property being set by the nice_agent_new() call.

The "max-connectivity-checks" property

  "max-connectivity-checks"  guint                 : Read / Write

Upper limit for the total number of connectivity checks performed.

Default value: 0

The "proxy-ip" property

  "proxy-ip"                 gchar*                : Read / Write

The proxy server IP used to bypass a proxy firewall

Default value: NULL

Since 0.0.4

The "proxy-password" property

  "proxy-password"           gchar*                : Read / Write

The password used to authenticate with the proxy

Default value: NULL

Since 0.0.4

The "proxy-port" property

  "proxy-port"               guint                 : Read / Write

The proxy server port used to bypass a proxy firewall

Allowed values: [1,65536]

Default value: 1

Since 0.0.4

The "proxy-type" property

  "proxy-type"               guint                 : Read / Write

The type of proxy set in the proxy-ip property

Allowed values: <= 2

Default value: 0

Since 0.0.4

The "proxy-username" property

  "proxy-username"           gchar*                : Read / Write

The username used to authenticate with the proxy

Default value: NULL

Since 0.0.4

The "reliable" property

  "reliable"                 gboolean              : Read / Write / Construct Only

Whether the agent should use PseudoTcp to ensure a reliable transport of messages

Default value: FALSE

Since 0.0.11

The "stun-pacing-timer" property

  "stun-pacing-timer"        guint                 : Read / Write / Construct Only

Timer 'Ta' (msecs) used in the IETF ICE specification for pacing candidate gathering and sending of connectivity checks.

Allowed values: >= 1

Default value: 20

The "stun-server" property

  "stun-server"              gchar*                : Read / Write

The IP address (not the hostname) of the STUN server to use.

Default value: NULL

The "stun-server-port" property

  "stun-server-port"         guint                 : Read / Write

Port of the STUN server used to gather server-reflexive candidates.

Allowed values: [1,65536]

Default value: 1

The "upnp" property

  "upnp"                     gboolean              : Read / Write / Construct

Whether the agent should use UPnP to open a port in the router and get the external IP

Default value: TRUE

Since 0.0.7

The "upnp-timeout" property

  "upnp-timeout"             guint                 : Read / Write / Construct

The maximum amount of time (in milliseconds) to wait for UPnP discovery to finish before signaling the "candidate-gathering-done" signal

Allowed values: [100,60000]

Default value: 200

Since 0.0.7

The "candidate-gathering-done" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        gpointer   user_data)      : Run Last

This signal is fired whenever a stream has finished gathering its candidates after a call to nice_agent_gather_candidates()

The "component-state-changed" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        guint      component_id,
                                                        guint      state,
                                                        gpointer   user_data)         : Run Last

This signal is fired whenever a component's state changes

The "initial-binding-request-received" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        gpointer   user_data)      : Run Last

This signal is fired when we received our first binding request from the peer.

The "new-candidate" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        guint      component_id,
                                                        gchar     *foundation,
                                                        gpointer   user_data)         : Run Last

This signal is fired when the agent discovers a new local candidate.

See also: "candidate-gathering-done"

The "new-remote-candidate" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        guint      component_id,
                                                        gchar     *foundation,
                                                        gpointer   user_data)         : Run Last

This signal is fired when the agent discovers a new remote candidate. This can happen with peer reflexive candidates.

The "new-selected-pair" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        guint      component_id,
                                                        gchar     *lfoundation,
                                                        gchar     *rfoundation,
                                                        gpointer   user_data)         : Run Last

This signal is fired once a candidate pair is selected for data transfer for a stream's component

The "reliable-transport-writable" signal

void                user_function                      (NiceAgent *agent,
                                                        guint      stream_id,
                                                        guint      component_id,
                                                        gpointer   user_data)         : Run Last

This signal is fired on the reliable NiceAgent when the underlying reliable transport becomes writable. This signal is only emitted when the nice_agent_send() function returns less bytes than requested to send (or -1) and once when the connection is established.

Since 0.0.11

The "streams-removed" signal

void                user_function                      (NiceAgent           *agent,
                                                        _NiceAgentStreamIds *stream_ids,
                                                        gpointer             user_data)       : Run Last

This signal is fired whenever one or more streams are removed from the agent.

Since 0.1.5