The read-only component
property on the RTCIceCandidate
interface is a string which indicates whether the candidate is an RTP or an RTCP candidate.
If a candidate represents both RTP and RTCP multiplexed together, it is reported as an RTP candidate.
Syntax
var component = RTCIceCandidate.component;
Value
A DOMString
which is "rtp"
for RTP (or RTP and RTCP multiplexed together) candidates or "rtcp"
for RTCP candidates.
Usage notes
Consider this SDP attribute line (a-line):
a=candidate:4234997325 1 udp 2043278322 192.168.0.56 44323 typ host
This is an ICE candidate a-line, whose foundation
is 4234997325. The next field on the a-line, "1"
, is the component ID. A value of "1"
indicates RTP, which is recorded in the component
property as "rtp"
. If this value were instead "2"
, the a-line would be describing an RTCP candidate, and compoment
would be "rtcp"
.
Example
This code snippet examines a candidate's component type and dispatches the candidate to different handlers depending on the value.
if (candidate.component == "rtp") { handleRTPCandidate(candidate); } else if (candidate.component == "rtcp") { handleRTCPCandidate(candidate); } else { handleUnknownCandidate(candidate); }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceCandidate.component' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
component | Chrome Full support 74 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera ? | Safari ? | WebView Android Full support 74 | Chrome Android Full support 74 | Firefox Android No support No | Opera Android ? | Safari iOS ? | Samsung Internet Android Full support 11.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown