nice_candidate_new ()

NiceCandidate *
nice_candidate_new (NiceCandidateType type);

Creates a new candidate. Must be freed with nice_candidate_free()

nice_candidate_free ()

void
nice_candidate_free (NiceCandidate *candidate);

Frees a NiceCandidate

nice_candidate_copy ()

NiceCandidate *
nice_candidate_copy (const NiceCandidate *candidate);

Makes a copy of a NiceCandidate

nice_candidate_equal_target ()

gboolean
nice_candidate_equal_target (const NiceCandidate *candidate1,
                             const NiceCandidate *candidate2);

Verifies that the candidates point to the same place, meaning they have the same transport and the same address. It ignores all other aspects.

Since: 0.1.15

nice_candidate_transport_to_string ()

const gchar *
nice_candidate_transport_to_string (NiceCandidateTransport transport);

Useful for debugging functions, just returns a static string with the candidate transport.

Since: 0.1.19

nice_candidate_type_to_string ()

const gchar *
nice_candidate_type_to_string (NiceCandidateType type);

Useful for debugging functions, just returns a static string with the candidate type.

Since: 0.1.19

nice_candidate_relay_address ()

void
nice_candidate_relay_address (const NiceCandidate *candidate,
                              NiceAddress *addr);

In case the given candidate is relayed through a TURN server, use this utility function to get its address.

Since: 0.1.19

nice_candidate_stun_server_address ()

gboolean
nice_candidate_stun_server_address (const NiceCandidate *candidate,
                                    NiceAddress *addr);

In case the given candidate server-reflexive, use this utility function to get its address. The address will be filled only if the candidate was generated using an STUN server.

Since: 0.1.20

struct NiceCandidate

struct NiceCandidate {
  NiceCandidateType type;
  NiceCandidateTransport transport;
  NiceAddress addr;
  NiceAddress base_addr;
  guint32 priority;
  guint stream_id;
  guint component_id;
  gchar foundation[NICE_CANDIDATE_MAX_FOUNDATION];
  gchar *username;        /* pointer to a nul-terminated username string */
  gchar *password;        /* pointer to a nul-terminated password string */
};

A structure to represent an ICE candidate

enum NiceCandidateType

An enum representing the type of a candidate

enum NiceCandidateTransport

An enum representing the type of transport to use

enum NiceRelayType

An enum representing the type of relay to use

NICE_CANDIDATE_MAX_FOUNDATION

#define NICE_CANDIDATE_MAX_FOUNDATION                (32+1)

The maximum size a candidate foundation can have.

NICE_CANDIDATE_MAX_TURN_SERVERS

#define NICE_CANDIDATE_MAX_TURN_SERVERS              8

The maximum number of turns servers.

NICE_CANDIDATE_MAX_LOCAL_ADDRESSES

#define NICE_CANDIDATE_MAX_LOCAL_ADDRESSES           64

The maximum number of local addresses. The constraint is that the maximum number of local addresses and number of turn servers must fit on 9 bits, to ensure candidate priority uniqueness. See also NICE_CANDIDATE_MAX_TURN_SERVERS . We choose 6 bits for the number of local addresses, and 3 bits for the number of turn servers.