The RTCPeerConnection.removeTrack()
method tells the local end of the connection to stop sending media from the specified track, without actually removing the corresponding RTCRtpSender
from the list of senders as reported by RTCPeerConnection.getSenders()
. If the track is already stopped, or is not in the connection's senders list, this method has no effect.
If the connection has already been negotiated (signalingState
is set to "stable"
), it is marked as needing to be negotiated again; the remote peer won't experience the change until this negotiation occurs. A negotiationneeded
event is sent to the RTCPeerConnection
to let the local end know this negotiation must occur.
Syntax
pc.removeTrack(sender);
Parameters
mediaTrack
- A
RTCRtpSender
specifying the sender to remove from the connection.
Return value
undefined
.
Exceptions
InvalidStateError
- The connection is not open.
Example
This example adds a video track to a connection and sets up a listener on a close button which removes the track when the user clicks the button.
var pc, sender; navigator.getUserMedia({video: true}, function(stream) { pc = new RTCPeerConnection(); var track = stream.getVideoTracks()[0]; sender = pc.addTrack(track, stream); }); document.getElementById("closeButton").addEventListener("click", function(event) { pc.removeTrack(sender); pc.close(); }, false);
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.removeTrack()' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
removeTrack | Chrome Full support 64 | Edge Full support ≤18 | Firefox Full support 22 | IE No support No | Opera Full support 51 | Safari Full support 11 | WebView Android Full support 64 | Chrome Android Full support 64 | Firefox Android Full support 44 | Opera Android Full support 47 | Safari iOS Full support Yes | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support