TsgcRTCPeerConnection › Methods › GatherCandidates

GatherCandidates Method

Starts the ICE candidate gathering process.

Syntax

procedure GatherCandidates;

Remarks

Entry point of the full WebRTC session. The method:

• Connects the internal signalling WebSocket client to the server configured in RTCOptions.WebSocket (firing OnRTCWebSocketBeforeConnect and OnRTCWebSocketConnect).
• Starts the ICE agent, which uses the configured STUN/TURN server to produce host, server-reflexive and relayed candidates. Each candidate is reported through OnRTCLocalCandidate and forwarded to the peer over the signalling channel.
• Triggers SDP negotiation; the local description is raised through OnRTCLocalDescription.

If the signalling WebSocket cannot be reached the method raises an exception; otherwise the handshake runs asynchronously until a candidate pair is nominated and OnRTCConnect is fired.

Example

oRTC.RTCOptions.WebSocket.Host := 'signal.server.com';
oRTC.RTCOptions.WebSocket.Port := 443;
oRTC.RTCOptions.WebSocket.TLS := True;
oRTC.RTCOptions.ICE.Host := 'turn.server.com';
oRTC.RTCOptions.ICE.Port := 3478;

// ... start signalling + ICE gathering
oRTC.GatherCandidates;

Back to Methods