RTCRtpSender extension type

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

With it, you can configure the encoding used for the corresponding track, get information about the device's media capabilities, and so forth. You can also obtain access to an RTCDTMFSender which can be used to send codes (to simulate the user pressing buttons on a telephone's dial pad) to the remote peer.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Properties

dtmf → RTCDTMFSender?
The read-only dtmf property on the RTCRtpSender interface returns a RTCDTMFSender object which can be used to send tones over the RTCPeerConnection. See Using DTMF for details on how to make use of the returned RTCDTMFSender object.
no setter
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
track → MediaStreamTrack?
The track read-only property of the RTCRtpSender interface returns the MediaStreamTrack which is being handled by the RTCRtpSender.
no setter
transform ↔ RTCRtpTransform?
The transform property of the RTCRtpSender object is used to insert a transform stream (TransformStream) running in a worker thread into the sender pipeline. This allows stream transforms to be applied to encoded video and audio frames after they are output by a codec, and before they are sent.
getter/setter pair
transport → RTCDtlsTransport?
The read-only transport property of an RTCRtpSender object provides the RTCDtlsTransport object used to interact with the underlying transport over which the sender is exchanging Real-time Transport Control Protocol () packets.
no setter

Methods

getParameters() → RTCRtpSendParameters
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.
getStats() → JSPromise<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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
replaceTrack(MediaStreamTrack? withTrack) → JSPromise<JSAny?>
The RTCRtpSender method replaceTrack() replaces the track currently being used as the sender's source with a new MediaStreamTrack.
setParameters(RTCRtpSendParameters parameters, [RTCSetParameterOptions setParameterOptions]) → JSPromise<JSAny?>
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.
setStreams(MediaStream streams) → void
The RTCRtpSender method setStreams() associates the sender's RTCRtpSender.track with the specified MediaStream objects.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

getCapabilities(String kind) → RTCRtpCapabilities?
The static method RTCRtpSender.getCapabilities() returns an object describing the codec and header extension capabilities supported by the RTCRtpSender.