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.
Methods
getParameters()
getParameters(): RTCRtpSendParameters;
The getParameters() method of the RTCRtpSender interface returns an object describing the current configuration for how the sender's track will be encoded and transmitted to a remote RTCRtpReceiver.
Returns
getStats()
getStats(): Promise<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.
Returns
Promise<RTCStatsReport>
replaceTrack()
replaceTrack(withTrack): Promise<void>;
The RTCRtpSender method replaceTrack() replaces the track currently being used as the sender's source with a new MediaStreamTrack.
Parameters
| Parameter | Type |
|---|---|
withTrack | MediaStreamTrack | null |
Returns
Promise<void>
setParameters()
setParameters(parameters, setParameterOptions?): Promise<void>;
The setParameters() method of the RTCRtpSender interface applies changes the configuration of sender's track, which is the MediaStreamTrack for which the RTCRtpSender is responsible.
Parameters
| Parameter | Type |
|---|---|
parameters | RTCRtpSendParameters |
setParameterOptions? | RTCSetParameterOptions |
Returns
Promise<void>
setStreams()
setStreams(...streams): void;
The RTCRtpSender method setStreams() associates the sender's track with the specified MediaStream objects.
Parameters
| Parameter | Type |
|---|---|
...streams | MediaStream[] |
Returns
void
Properties
dtmf
readonly dtmf: RTCDTMFSender | null;
The read-only dtmf property on the RTCRtpSender interface returns a RTCDTMFSender object which can be used to send DTMF tones over the RTCPeerConnection. See Using DTMF for details on how to make use of the returned RTCDTMFSender object.
track
readonly track: MediaStreamTrack | null;
The track read-only property of the RTCRtpSender interface returns the MediaStreamTrack which is being handled by the RTCRtpSender.
transform
transform: RTCRtpScriptTransform | null;
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.
transport
readonly transport: RTCDtlsTransport | null;
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 (RTCP) packets.