MediaStreamTrack.applyConstraints()

The applyConstraints() method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the Web site or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancelation, and so forth.

Constraints can be used to ensure that the media meets certain guidelines you prefer. For example, you may prefer high density video but require that the frame rate be a little low to help keep the data rate low enough not overtax the network. Constraints can also specify ideal and/or acceptable sizes or ranges of sizes. See Applying constraints in Capabilities, constraints, and settings for more information on how to apply your preferred constraints.

Syntax

var appliedPromise = MediaStreamTrack.applyConstraints(constraints);

Parameters

constraints Optional
A MediaTrackConstraints object listing the constraints to apply to the track's constrainable properties; any existing constraints are replaced with the new values specified, and any constrainable properties not included are restored to their default constraints. If this parameter is omitted, all currently set custom constraints are cleared. This object represents the basic set of constraints that must apply for the Promise to resolve. The object may contain an advanced property containing an array of additional MediaTrackConstrants objects, which are treated as exact requires. 

Return value

A Promise which resolves when the constraints have been successfully applied. If the constraints cannot be applied, the promise is rejected with a MediaStreamError whose name is OverconstrainedError, to indicate that the constraints could not be met. This can happen if the specified constraints are too strict to find a match when attempting to configure the track.

Examples

The following shows how to specify a basic and advanced set of constraints. It specifies that the page or web app needs a width between 640 and 1280 and a height between 480 and 720, with the later number in each pair being prefered. The advanced property further specifies that an image size of 1920 by 1280 is the preferred or an aspect ration of 1.333 if that is not available. Note that these contraints also illustrate what the spec refers to as a backoff strategy.

const constraints = {
  width: {min: 640, ideal: 1280},
  height: {min: 480, ideal: 720},
  advanced: [
    {width: 1920, height: 1280},
    {aspectRatio: 1.333}
  ]
};

navigator.mediaDevices.getUserMedia({ video: true })
.then(mediaStream => {
  const track = mediaStream.getVideoTracks()[0];
  track.applyConstraints(constraints)
  .then(() => {
    // Do something with the track such as using the Image Capture API.
  }
  .catch(e => {
    // The constraints could not be satisfied by the available devices.
  }
}

Specifications

Specification Status Comment
Media Capture and Streams
The definition of 'applyConstraints()' in that specification.
Editor's Draft Initial definition.
MediaStream Image Capture
The definition of 'applyConstraints()' in that specification.
Working Draft Adds image constraints.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support 59 43 (43) ? 46 ?
Media Capture constraints 63 ? ? 50 ?
MediaStream Image Capture constraints 59 ? ? 46 ?
Feature Android Webview Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support 59 59 43.0 (43) ? 46 ?
Media Capture constraints 63 63 ? ? 50 ?
MediaStream Image Capture constraints 59 59 ? ? 46 ?

See also

Document Tags and Contributors

 Contributors to this page: jpmedley, tkbremnes, ChibiDenDen, Sheppy
 Last updated by: jpmedley,