Web/API/RTCIceCandidate/tcpType

The RTCIceCandidate interface's read-only tcpType property is included on TCP candidates to provide additional details about the candidate type.

The tcpType field's value is set when the RTCIceCandidate() constructor is used. You can't directly set its value; instead, its value is automatically extracted from the candidate a-line, if it's formatted properly.

Syntax

var tcpType = RTCIceCandidate.tcpType;

Value

A DOMString whose value is one of those defined by the RTCIceTcpCandidateType enumerated type.

"active": The transport will try to open an outbound connection but won't receive inoming connection requests.
"passive": The transport will receive incoming connection requests but won't try to open an outbound connection.
"so": The transport will try to open a connection simultaneously with its peer.

tcpType is null for UDP candidates.

Example

In this example, the candidate's protocol and tcpType are used to adjust the user interface for simultaneous-open TCP candidates.

if (candidate.protocol == "tcp" && candidate.tcpType == "so") {
    adjustForSimultaneousOpen(candidate);
}

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCIceCandidate.tcpType' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`tcpType`	Chrome Full support 74	Edge Full support ≤18	Firefox No support No	IE No support No	Opera No support No	Safari ?	WebView Android Full support 74	Chrome Android Full support 74	Firefox Android No support No	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 11.0

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown