The optional property usernameFragment
in the RTCIceCandidateInit
dictionary specifies the value of the RTCIceCandidate
object's usernameFragment
property.
Value
A DOMString
containing the username fragment (usually referred to in shorthand as "ufrag" or "ice-ufrag") that, along with the ICE password ("ice-pwd"), uniquely identifies a single ongoing ICE interaction, including for any communication with the STUN server. The string may be up to 256 characters long, and has no default value.
Randomization
At least 24 bits of the text in the ufrag
are required to be randomly selected by the ICE layer at the beginning of the ICE session. The specifics for which bits are random and what the remainder of the ufrag
text are are left up to the browser implementation to decide. For example, a browser might choose to always use a 24-character ufrag
in which bit 4 of each character is randomly selected between 0 and 1. Another example: it might take a user-defined string and append three 8-bit random bytes to the end. Or perhaps every character is entirely random.
Example
...
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCIceCandidateInit.usernameFragment' in that specification. | Candidate Recommendation | Initial specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
usernameFragment
|
Chrome
Full support Yes |
Edge
Full support ≤18 |
Firefox
Full support 67 |
IE
No support No |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support 67 |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support Yes |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- WebRTC API
RTCIceCandidate.usernameFragment
RTCPeerConnection.addIceCandidate()
icecandidate
- Lifetime of a WebRTC session
RTCIceCandidateInit.usernameFragment by Mozilla Contributors is licensed under CC-BY-SA 2.5.