addIceCandidate

Summary

Provides a remote candidate to the ICE agent.

Method of apis/webrtc/RTCPeerConnectionapis/webrtc/RTCPeerConnection

Syntax

 element.addIceCandidate(candidate);

Parameters

candidate

Data-type

RTCIceCandidate

See RTCIceCandidate.

Return Value

No return value

Usage

 An exception with an RTCError object of type INVALID_CANDIDATE_TYPE is thrown if candidate parameter is malformed.

Notes

In addition to being added to the remote description, connectivity checks will be sent to the new candidates as long as the IceTransports constraint is not set to none. This call will result in a change to the state of the ICE Agent, and may result in a change to media state if it results in different connectivity being established.