RTCRtpSender

The RTCRtpSender interface provides the ability to control and obtain details about how a particular MediaStreamTrack is encoded and sent to a remote peer.

MDN Reference

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The read-only dtmf property on the RTCRtpSender interface returns a over the RTCPeerConnection.

Link copied to clipboard

The track read-only property of the RTCRtpSender interface returns the MediaStreamTrack which is being handled by the RTCRtpSender.

Link copied to clipboard

The transform property of the RTCRtpSender object is used to insert a transform stream (TransformStream) running in a worker thread into the sender pipeline.

Link copied to clipboard

The read-only transport property of an used to interact with the underlying transport over which the sender is exchanging Real-time Transport Control Protocol (RTCP) packets.

Functions

Link copied to clipboard

The getParameters() method of the RTCRtpSender interface returns an object describing the current configuration for how the sender's RTCRtpSender.track will be encoded and transmitted to a remote RTCRtpReceiver.

Link copied to clipboard
suspend fun getStats(): RTCStatsReport

The RTCRtpSender method getStats() asynchronously requests an RTCStatsReport object which provides statistics about outgoing traffic on the RTCPeerConnection which owns the sender, returning a Promise which is fulfilled when the results are available.

Link copied to clipboard
Link copied to clipboard
suspend fun replaceTrack(withTrack: MediaStreamTrack?)

The RTCRtpSender method replaceTrack() replaces the track currently being used as the sender's source with a new MediaStreamTrack.

Link copied to clipboard
Link copied to clipboard
suspend fun setParameters(parameters: RTCRtpSendParameters, setParameterOptions: RTCSetParameterOptions = definedExternally)

The setParameters() method of the RTCRtpSender interface applies changes the configuration of sender's RTCRtpSender.track, which is the MediaStreamTrack for which the RTCRtpSender is responsible.

Link copied to clipboard
fun setParametersAsync(parameters: RTCRtpSendParameters, setParameterOptions: RTCSetParameterOptions = definedExternally): Promise<Void>
Link copied to clipboard
fun setStreams(vararg streams: MediaStream)

The RTCRtpSender method setStreams() associates the sender's RTCRtpSender.track with the specified MediaStream objects.