BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJMEDIA Reference

pjmedia_ice_cb Struct Reference

Data Fields

void(* on_ice_complete )(pjmedia_transport *tp, pj_ice_strans_op op, pj_status_t status)
 
void(* on_ice_complete2 )(pjmedia_transport *tp, pj_ice_strans_op op, pj_status_t status, void *user_data)
 
void(* on_new_candidate )(pjmedia_transport *tp, const pj_ice_sess_cand *cand, pj_bool_t last)
 

Detailed Description

Structure containing callbacks to receive ICE notifications.

Field Documentation

◆ on_ice_complete

void(* pjmedia_ice_cb::on_ice_complete) (pjmedia_transport *tp, pj_ice_strans_op op, pj_status_t status)

This callback will be called when ICE negotiation completes.

Parameters
tpPJMEDIA ICE transport.
opThe operation
statusOperation status.

◆ on_ice_complete2

void(* pjmedia_ice_cb::on_ice_complete2) (pjmedia_transport *tp, pj_ice_strans_op op, pj_status_t status, void *user_data)

This callback will be called when ICE negotiation completes, with application user data. Note that if both callbacks are implemented, only this callback will be invoked.

Parameters
tpPJMEDIA ICE transport.
opThe operation
statusOperation status.
user_dataUser data for this callback.

◆ on_new_candidate

void(* pjmedia_ice_cb::on_new_candidate) (pjmedia_transport *tp, const pj_ice_sess_cand *cand, pj_bool_t last)

Callback to report a new ICE local candidate, e.g: after successful STUN Binding, after a successful TURN allocation. Only new candidates whose type is server reflexive or relayed will be notified via this callback. This callback also indicates end-of-candidate via parameter 'last'.

Trickle ICE can use this callback to convey the new candidate to remote agent and monitor end-of-candidate indication.

Parameters
tpPJMEDIA ICE transport.
candThe new local candidate, can be NULL when the last local candidate initialization failed/timeout.
lastPJ_TRUE if this is the last of local candidate.

The documentation for this struct was generated from the following file:

 


PJMEDIA small footprint Open Source media stack
Copyright (C) 2006-2008 Teluu Inc.