The stop()
method in the RTCRtpTransceiver
interface permanently stops the transceiver by stopping both the associated RTCRtpSender
and RTCRtpReceiver
.
Note: Until recently, the stopped
property was provided to return true
if the connection is stopped. That property has been deprecated and will be removed at some point. Instead, check the value of currentDirection
. If it's stopped
, the transceiver has been stopped.
This method does nothing if the transceiver is already stopped.
Syntax
RTCRtpTransceiver.stop()
Paramters
None.
Return value
undefined
Exceptions
InvalidStateError
- The
RTCPeerConnection
of which the transceiver is a member is closed.
Usage notes
When you call stop()
on a transceiver, the sender immediately stops sending media and each of its RTP streams are closed using the RTCP "BYE"
message. The receiver then stops receiving media; the receiver's track
is stopped, and the transceiver's direction
is changed to stopped
, and renegotiation is triggered by sending a negotiationneeded
event to the RTCPeerConnection
.
The negotiation process causes currentNegotiation
to be set to stopped
, finally indicating that the transceiver has been fully stopped.
Note: Stopping the transceiver causes a negotiationneeded
event to be sent to the transceiver's RTCPeerConnection
, so the connection can adapt to the change.
Specifications
Specification | Status | Comment |
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCRtpTransceiver.stop()' in that specification. | Candidate Recommendation |
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
stop()
|
Chrome
No support No |
Edge
No support No |
Firefox
Full support 59 |
IE
No support No |
Opera
No support No |
Safari
Full support Yes |
WebView Android
No support No |
Chrome Android
No support No |
Firefox Android
Full support 59 |
Opera Android
No support No |
Safari iOS
Full support Yes |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
See also
RTCRtpTransceiver.stop() by Mozilla Contributors is licensed under CC-BY-SA 2.5.