TsgcICEClient › Events

TsgcICEClient Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Candidate discovery

NameDescription
OnICECandidateFires once per local candidate discovered during gathering; forward the candidate to the remote peer via signalling.
OnICECandidateErrorFires when candidate gathering fails for a specific STUN or TURN probe; inspect the error details to diagnose.

Candidate pair

NameDescription
OnICECandidatePairNominatedFires when a candidate pair passes connectivity checks and is nominated as the selected path for the session.
OnICECandidatePairFailedFires when a candidate pair fails connectivity checks; the pair is dropped and the next one in the check list is tried.
OnICEReceiveBindingRequestFires for each STUN binding request received from the peer during connectivity checks; set Accept to allow the probe.

Errors

NameDescription
OnICEExceptionFires when an unhandled internal exception is raised while processing ICE candidates or connectivity checks.

All Events (alphabetical)

NameDescription
OnICECandidateFires once per local candidate discovered during gathering; forward the candidate to the remote peer via signalling.
OnICECandidateErrorFires when candidate gathering fails for a specific STUN or TURN probe; inspect the error details to diagnose.
OnICECandidatePairFailedFires when a candidate pair fails connectivity checks; the pair is dropped and the next one in the check list is tried.
OnICECandidatePairNominatedFires when a candidate pair passes connectivity checks and is nominated as the selected path for the session.
OnICEExceptionFires when an unhandled internal exception is raised while processing ICE candidates or connectivity checks.
OnICEReceiveBindingRequestFires for each STUN binding request received from the peer during connectivity checks; set Accept to allow the probe.