An RTCIceGatherer instance can be associated to multiple RTCIceTransport objects.
The RTCIceGatherer does not prune local candidates until at least one RTCIceTransport
- object has become associated and all associated RTCIceTransport objects are in the "completed" or
- "failed" state.
+ object has become associated and all associated RTCIceTransport objects are in the completed or
+ failed state.
As noted in [[!RFC5245]] Section 7.1.2.2, an incoming connectivity check contains an ICE-CONTROLLING
@@ -165,7 +165,7 @@
RTCIceGatherer instance is constructed from an RTCIceGatherOptions object.
- An RTCIceGatherer object in the "closed" state can be garbage-collected
+ An RTCIceGatherer object in the closed state can be garbage-collected
when it is no longer referenced.
The component-id of the RTCIceGatherer object. In RTCIceGatherer
- objects returned by createAssociatedGatherer() the value of component is "RTCP". In all
- other RTCIceGatherer objects, the value of component is "RTP".
+ objects returned by createAssociatedGatherer() the value of component is RTCP.
+ In all other RTCIceGatherer objects, the value of component is RTP.
- Prunes all local candidates, and closes the port. Associated RTCIceTransport objects transition to the "disconnected" state
- (unless they were in the "failed" state).
- Calling close() when state is "closed" has no effect.
+ Prunes all local candidates, and closes the port. Associated RTCIceTransport
+ objects transition to the disconnected state
+ (unless they were in the failed state).
+ Calling close() when state is closed has no effect.
Create an associated RTCIceGatherer for RTCP, with the same
RTCIceParameters and RTCIceGatherOptions.
- If state is "closed", throw an InvalidStateError exception.
+ If state is closed, throw an InvalidStateError exception.
If an RTCIceGatherer calls the method more than once,
- or if component is "RTCP", throw
+ or if component is RTCP, throw
an InvalidStateError exception.
- If only ICE-lite is supported (true) or not (false or unset). Since
+ If only ICE-lite is supported (true) or not (false or unset). Since
[[!RTCWEB-TRANSPORT]] Section 3.4 requires browser support for full ICE,
- iceLite will only be "true" for a remote peer such as
+ iceLite will only be true for a remote peer such as
a gateway. getLocalParameters().iceLite MUST NOT be set.
This attribute is always present and set to true, indicating that ICE candidate gathering is complete.
+This attribute is always present and set to true, indicating that ICE candidate gathering is complete.
The RTCIceGatherer has completed gathering. Events such as adding, updating or removing an interface,
- or adding, changing or removing a TURN server will cause the state to go back to gathering before re-entering
- "complete" once all candidate changes are finalized.
+ or adding, changing or removing a TURN server will cause the state to go back to gathering before re-entering
+ complete once all candidate changes are finalized.
RTCIceGathererState of "gathering".
+ RTCIceGathererState of gathering.
An RTCIceTransport instance is constructed (optionally) from an RTCIceGatherer.
- If gatherer.state is "closed" or gatherer.component is "RTCP", then throw an InvalidStateError exception.
+ If gatherer.state is closed or gatherer.component is RTCP, then throw an InvalidStateError exception.
- An RTCIceTransport object in the "closed" state can be garbage-collected
+ An RTCIceTransport object in the closed state can be garbage-collected
when it is no longer referenced.
The component-id of the RTCIceTransport object. In RTCIceTransport
objects returned by createAssociatedTransport(), the value of component is
- "RTCP". In all other RTCIceTransport objects, the value of component is "RTP".
+ RTCP. In all other RTCIceTransport objects, the value of component is RTP.
RTCIceTransport.
If start() is called with invalid parameters, throw an InvalidParameters exception.
For example, if gatherer.component has a value different from iceTransport.component,
- throw an InvalidParameters exception. If state or gatherer.state is "closed",
+ throw an InvalidParameters exception. If state or gatherer.state is closed,
throw an InvalidStateError exception. When start() is called again,
- RTCIceTransportState transitions to the "connected" state, all remote candidates
+ RTCIceTransportState transitions to the connected state, all remote candidates
are flushed, and addRemoteCandidate() or setRemoteCandidates() must be called
to add the remote candidates back or replace them.
@@ -992,7 +993,7 @@
Stops and closes the current object. Also removes the object from the
RTCIceTransportController.
- Calling stop() when state is "closed" has no effect.
+ Calling stop() when state is closed has no effect.
Create an associated RTCIceTransport for RTCP.
- If called more than once for the same component, or if state is "closed",
+ If called more than once for the same component, or if state is closed,
throw an InvalidStateError exception. If called when
- component is "RTCP",
+ component is RTCP,
throw an InvalidStateError exception.
Add a remote candidate associated with the remote RTCIceTransport.
- If state is "closed", throw an InvalidStateError exception.
+ If state is closed, throw an InvalidStateError exception.
When the remote RTCIceGatherer emits its final candidate, addRemoteCandidate() should be called
with an RTCIceCandidateComplete dictionary as an argument, so that the local RTCIceTransport can
- know there are no more remote candidates expected, and can enter the "completed" state.
+ know there are no more remote candidates expected, and can enter the completed state.
Set the sequence of candidates associated with the remote RTCIceTransport.
- If state is "closed", throw an InvalidStateError exception.
+ If state is closed, throw an InvalidStateError exception.
- RTCIceComponent contains the component-id of the RTCIceTransport, which will be "RTP" unless RTP and RTCP are not multiplexed and
+ RTCIceComponent contains the component-id of the RTCIceTransport,
+ which will be RTP unless RTP and RTCP are not multiplexed and
the RTCIceTransport object was returned by createAssociatedTransport().
checking
+ (if there are candidate pairs remaining to be checked) or disconnected (if there are no candidate
pairs to check, but the peer is still gathering and/or waiting for additional remote candidates).
@@ -1122,7 +1124,7 @@ RTCIceTransport and all appropriate candidate
pairs have been tested and at least one functioning candidate pair has been found.
If consent checks [[!RFC7675]] subsequently fail on all successful candidate pairs,
- the state transitions to "failed".
+ the state transitions to failed.
RTCIceCandidateComplete dictionary was not added as the last
candidate, but all appropriate candidate pairs thus far have been tested and failed (or consent checks [[!RFC7675]]
once successful, have now failed). Other candidate pairs may become available for testing as new candidates
- are trickled, and therefore the "failed" state has not been reached.
+ are trickled, and therefore the failed state has not been reached.
start() is called).
- If an attempt is made to construct a RTCDtlsTransport instance from an RTCIceTransport in the "closed" state,
+ If an attempt is made to construct a RTCDtlsTransport instance from an RTCIceTransport in the closed state,
an InvalidStateError exception is thrown.
Since the Datagram Transport Layer Security (DTLS) negotiation occurs between transport endpoints determined via ICE, implementations of this specification
MUST support multiplexing of STUN, TURN, DTLS and RTP and/or RTCP.
This multiplexing, originally described in [[!RFC5764]] Section 5.1.2, is being revised in [[MUX-FIXES]].
- An RTCDtlsTransport object in the "closed" or "failed" states can be garbage-collected
+ An RTCDtlsTransport object in the closed or failed states can be garbage-collected
when it is no longer referenced.
Returns the certificate chain in use by the remote side, with each certificate encoded
in binary Distinguished Encoding Rules (DER) [[!X690]]. getRemoteCertificates()
returns an empty list prior to selection of the remote certificate, which is completed
- once RTCDtlsTransportState transitions to "connected".
RTCDtlsTransportState transitions to connected.
If remoteParameters is invalid, throw
an InvalidParameters exception. If start() is called
- after a previous start() call, or if state is "closed",
+ after a previous start() call, or if state is closed,
throw an InvalidStateError exception.
Only a single DTLS transport can be multiplexed over an ICE transport.
Therefore if a RTCDtlsTransport object dtlsTransportB
@@ -1479,7 +1481,7 @@
Stops and closes the RTCDtlsTransport object.
- Calling stop() when state is "closed" has no effect.
+ Calling stop() when state is closed has no effect.
The DTLS role, with a default of auto.
+The DTLS role, with a default of auto.
The DTLS role is determined based on the resolved ICE role: the
- "controlled" role acts as the DTLS client,
- the "controlling" role acts as the DTLS server. Since RTCDtlsRole
- is initialized to "auto" on construction of an RTCDtlsTransport object,
- transport.getLocalParameters().RTCDtlsRole will have an initial value of "auto".
+ controlled role acts as the DTLS client,
+ the controlling role acts as the DTLS server. Since RTCDtlsRole
+ is initialized to auto on construction of an RTCDtlsTransport object,
+ transport.getLocalParameters().RTCDtlsRole will have an initial value of auto.
The DTLS client role.
- A transition to "client" will occur if
+ A transition to client will occur if
start(remoteParameters) is called with remoteParameters.RTCDtlsRole
- having a value of "server". If RTCDtlsRole had previously had a value of "server" (e.g. due to
+ having a value of server. If RTCDtlsRole had previously had a value of server (e.g. due to
the RTCDtlsTransport having previously received packets from a DTLS client), then the
- DTLS session is reset prior to transitioning to the "client" role.
+ DTLS session is reset prior to transitioning to the client role.
- The DTLS server role. If RTCDtlsRole has a value of "auto" and the RTCDtlsTransport receives a DTLS client_hello packet,
- RTCDtlsRole will transition to "server", even before start() is called. A transition from "auto"
- to "server" will also occur if start(remoteParameters) is called with remoteParameters.RTCDtlsRole
- having a value of "client".
+ The DTLS server role. If RTCDtlsRole has a value of auto and
+ the RTCDtlsTransport receives a DTLS client_hello packet,
+ RTCDtlsRole will transition to server, even before start() is called. A transition from auto
+ to server will also occur if start(remoteParameters) is called with remoteParameters.RTCDtlsRole
+ having a value of client.
The DTLS connection has been closed intentionally via a call to stop() or receipt of a
close_notify alert. Calling transport.stop() will also result in a transition to the
- "closed" state.
+ closed state.
A RTCRtpSender instance is constructed from an MediaStreamTrack object and
associated to an RTCDtlsTransport.
- If an attempt is made to construct an RTCRtpSender object with transport.state or rtcpTransport.state "closed",
- or if track.readyState is "ended", throw an InvalidStateError exception.
+ If an attempt is made to construct an RTCRtpSender object with transport.state
+ or rtcpTransport.state closed,
+ or if track.readyState is ended, throw an InvalidStateError exception.
An RTCRtpSender object can be garbage-collected once stop()
@@ -1857,7 +1861,7 @@
sender.send(parameters)
had parameters.rtcp.mux set to false, throw an InvalidParameters
exception.
- If stop() has been called, or transport.state or rtcpTransport.state is "closed",
+ If stop() has been called, or transport.state or rtcpTransport.state is closed,
throw an InvalidStateError exception.
@@ -2092,9 +2096,9 @@ RTCDtlsTransport object.
If an attempt is made to construct an RTCRtpReceiver
object with transport.state or
- rtcpTransport.state with a value of "closed",
+ rtcpTransport.state with a value of closed,
throw an InvalidStateError exception.
- Upon construction, track is set, and the value of
+ Upon construction, track is set, and the value of
track.kind is determined based on the
value of kind passed in the constructor.
@@ -2142,7 +2146,7 @@ parameters.rtcp.mux set to false,
throw an InvalidParameters exception. If stop()
has been called, or transport.state
- or rtcpTransport.state is "closed",
+ or rtcpTransport.state is closed,
throw an InvalidStateError exception.
@@ -2186,7 +2190,7 @@
If rtcpTransport is not set and withParameters.rtcp.mux
- is set to "false", return a promise rejected with InvalidParameters.
+ is set to false, return a promise rejected with InvalidParameters.
- Whether the last RTP packet received from this source contains voice activity ("true") or not ("false"). Since
+ Whether the last RTP packet received from this source contains voice activity (true) or not (false). Since
the "V" bit is supported in [[!RFC6464]] but not [[!RFC6465]], the voiceActivityFlag attribute will only be set
- when receivers enable the client-mixer header extension (setting the vad attribute to "true"),
+ when receivers enable the client-mixer header extension (setting the vad attribute to true),
and when RTP packets are received from senders enabling the client-mixer header extension
- (setting the vad attribute to "true").
+ (setting the vad attribute to true).
An RTCIceTransportController object provides methods to add and retrieve RTCIceTransport
- objects with a component of "RTP" (associated RTCIceTransport objects with a component
- of "RTCP" are included implicitly).
+ objects with a component of RTP (associated RTCIceTransport objects with a component
+ of RTCP are included implicitly).
RTCIceTransports
- with a component of "RTP",
+ with a component of RTP,
throw an InvalidParameters exception.
- If transport.state is "closed", throw an InvalidStateError exception.
+ If transport.state is closed, throw an InvalidStateError exception.
If transport has already been added to another
RTCIceTransportController object,
- or if transport.component is "RTCP", throw an InvalidStateError exception.
+ or if transport.component is RTCP, throw an InvalidStateError exception.
- Returns the RTCIceTransport objects with a component of "RTP".
+ Returns the RTCIceTransport objects with a component of RTP.
If addTransport() has not been called, an empty list is returned.
The RTCRtpListener maintains three tables in order to facilitate matching: the ssrc_table which maps SSRC
values to RTCRtpReceiver objects; the muxId_table which maps values of the MID header extension
- to RTCRtpReceiverobjects and the pt_table which maps payload type values to
+ to RTCRtpReceiver objects and the pt_table which maps payload type values to
RTCRtpReceiver objects.
@@ -3100,7 +3104,8 @@
DOMString
auto, music and voice.DOMString
voip, audio and lowdelay.boolean
true) or not (if false).boolean
true) or variable bitrate (if false).boolean
true) or not (if false).boolean
true) or not (if false).send(),
the browser behaves as though a single encodings[0] entry was provided, with
encodings[0].ssrc set to a browser-determined value, encodings[0].active
- set to "true", encodings[0].codecPayloadType set to codecs[j].payloadType
+ set to true, encodings[0].codecPayloadType set to codecs[j].payloadType
where j is the index of the first codec that is not "cn", "telephone-event",
"red", "rtx" or a forward error correction codec ("ulpfec" [[RFC5109]] or "flexfec" [[FLEXFEC]]),
and all the other parameters.encodings[0] attributes (e.g. fec, rtx, priority,
@@ -3496,7 +3503,7 @@
- Whether reduced size RTCP [[!RFC5506]] is configured (if true) or compound RTCP as specified in [[!RFC3550]] (if false).
+ Whether reduced size RTCP [[!RFC5506]] is configured (if true) or compound RTCP as specified in [[!RFC3550]] (if false).
The default is false.
true. If set to false, the
RTCIceTransport
MUST have an associated RTCIceTransport object with
- a component of "RTCP",
+ a component of RTCP,
in which case RTCP will be sent on the associated RTCIceTransport.
@@ -3603,7 +3610,7 @@ boolean
true) or variable bitrate (if false).boolean
true) or not (if false).boolean
true) or not (if false).unsigned long
DOMString
auto, music and voice.DOMString
voip, audio and lowdelay.boolean
true) or not (if false).
For an RTCRtpSender, indicates whether this encoding is actively being sent.
- Setting it to false causes this encoding to no longer be sent.
- Setting it to true causes this encoding to be sent. If unset, the default (true) is assumed.
+ Setting it to false causes this encoding to no longer be sent.
+ Setting it to true causes this encoding to be sent. If unset, the default (true) is assumed.
For an RTCRtpReceiver, indicates that this encoding is being decoded.
- Setting it to false causes this encoding to no longer be decoded.
- Setting it to true causes this encoding to be decoded. If unset, the default (true) is assumed.
- Setting active to "false" is different than omitting the encoding, since
+ Setting it to false causes this encoding to no longer be decoded.
+ Setting it to true causes this encoding to be decoded. If unset, the default (true) is assumed.
+ Setting active to false is different than omitting the encoding, since
it can keep resources available to re-activate more quickly than re-adding the encoding.
- As noted in [[RFC3264]] Section 5.1, RTCP is still sent, regardless of the value of the active attribute.
+ As noted in [[RFC3264]] Section 5.1, RTCP is still sent, regardless of the value of the active attribute.
- If true, it is preferred that the value in the header be
+ If true, it is preferred that the value in the header be
encrypted as per [[!RFC6904]]. Default is to prefer unencrypted.
If true, the value in the header is encrypted as per [[!RFC6904]]. Default is unencrypted.
+If true, the value in the header is encrypted as per [[!RFC6904]]. Default is unencrypted.
RTCRtpSender, the vad attribute indicates whether the V bit is in use (true) or not (false).
+ For an RTCRtpSender, the vad attribute indicates whether the V bit is in use (true) or not (false).
For an RTCRtpReceiver, the vad attribute indicates whether the V bit is provided to the
- application (true) in RTCRtpContributingSource.voiceActivityFlag or is unset (false).
+ application (true) in RTCRtpContributingSource.voiceActivityFlag or is unset (false).
An RTCDataChannel object is constructed from a RTCDataTransport object and
an RTCDataChannelParameters object. If parameters is invalid, throw an
- InvalidParameters exception. If transport.state is "closed", throw an
+ InvalidParameters exception. If transport.state is closed, throw an
InvalidState exception.
An RTCDataChannel object can be garbage-collected once readyState
- is "closed" and it is no longer referenced.
+ is closed and it is no longer referenced.
RTCIceGatherer closed state, as noted in:
+ Updated description of RTCIceGatherer closed state, as noted in:
Issue 476
RTCDtlsTransportState, as noted in:
+ Added the failed state to RTCDtlsTransportState, as noted in:
Issue 219
RTCIceTransportState, as noted in:
+ Added the failed state to RTCIceTransportState, as noted in:
Issue 199
RTCIceGatherer.close() and the "closed" state, as noted in:
+ Updated the description of RTCIceGatherer.close() and the closed state, as noted in:
Issue 208
RTCIceTransport, RTCDtlsTransport
- and RTCIceGatherer objects in the "closed" state, as noted in:
+ and RTCIceGatherer objects in the closed state, as noted in:
Issue 186