RTCRtpEncodingParameters.scaleResolutionDownBy

The RTCRtpEncodingParameters dictionary's scaleResolutionDownBy property can be used to specify a factor by which to reduce the size of a video track during encoding.

This property is only available for tracks whose kind is video.

Syntax

rtpEncodingParameters.scaleResolutionDownBy = scalingFactor;

rtpEncodingParameters = {
  scaleResolutionDownBy: scalingFactor
};

Value

A double-precison floating-point number specifying the amount by which to reduce the size of the video during encoding. The default value, 1.0, means that the video will be encoded at its original size. A value of 2.0 would reduce the size of the video by a factor of 2 both horizontally and vertically, resulting in a video 25% the original size.

A value less than 1.0 would cause the video to get larger rather than smaller, which is not the intent of this property. Therefore, specifying a value less than 1.0 is not permitted and will cause a RangeError exception to be thrown by RTCPeerConnection.addTransceiver() or RTCRtpSender.setParameters().

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCRtpEncodingParameters.scaleResolutionDownBy' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
scaleResolutionDownByChrome No support NoEdge ? Firefox Full support 46IE No support NoOpera ? Safari ? WebView Android No support NoChrome Android No support NoFirefox Android Full support 46Opera Android ? Safari iOS ? Samsung Internet Android ?

Legend

Full support Ā 
Full support
No support Ā 
No support
Compatibility unknown Ā 
Compatibility unknown