RTCRtpTransceiver.stop

The stop() method in the RTCRtpTransceiver interface permanently stops the transceiver by stopping both the associated RTCRtpSender and RTCRtpReceiver. Once stopped, the transceiver's stopped property will return true.

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 stopped property is set to true.

At that point, currentDirection is set to null and a negotiationneeded event is scheduled to be sent to the RTCPeerConnection.

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• WebRTC API
• Introduction to the Real-time Transport Protocol (RTP)
• MediaStreamTrack