The RTCIceCandidate
interface's read-only port
property contains the port number on the device at the address given by ip
at which the candidate's peer can be reached.
As is the case with most of RTCIceCandidate
's properties, the value of port
is extracted from the candidate
a-line string specified when creating the RTCIceCandidate
. The a-line string is obtained either from the RTCIceCandidateInit
property candidate
or from a-line string passed into the constructor upon using new RTCIceCandidate()
.
Syntax
var port = RTCIceCandidate.port;
Value
A 16-bit number indicating the port number on the device at the address indicated by ip
at which the candidate's peer can be reached.
port
is initialized to null
if it is not specified in the candidate
, or if the candidate
string can't be parsed propertly.
Note: If port
is null
, passing the candidate to addIceCandidate()
will fail, throwing an OperationError
exception. This applies only if the candidate implements port
.
Usage notes
Consider this SDP attribute line (a-line) which describes an ICE candidate:
a=candidate:4234997325 1 udp 2043278322 192.168.0.56 44323 typ host
The port number is found in the sixth field, which is "44323"
. In this case, the value of port
will be 44323.
Example
This code snippet fetches the IP address and port number of the candidate, storing them into an object for future use.
var candidateLoc = { address: candidate.ip, port: candidate.port }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceCandidate.port' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
port | 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