ContextQMD
Back to Content

MediaTrackSupportedConstraints

files/en-us/web/api/mediatracksupportedconstraints/index.md

latest6.8 KB
Original Source

{{APIRef("Media Capture and Streams")}}

The MediaTrackSupportedConstraints dictionary establishes the list of constrainable properties recognized by the {{Glossary("user agent")}} or browser in its implementation of the {{domxref("MediaStreamTrack")}} object. An object conforming to MediaTrackSupportedConstraints is returned by {{domxref("MediaDevices.getSupportedConstraints()")}}.

Because of the way interface definitions in WebIDL work, if a constraint is requested but not supported, no error will occur. Instead, the specified constraints will be applied, with any unrecognized constraints stripped from the request. That can lead to confusing and hard to debug errors, so be sure to use getSupportedConstraints() to retrieve this information before attempting to establish constraints if you need to know the difference between silently ignoring a constraint and a constraint being accepted.

An actual constraint set is described using an object based on the {{domxref("MediaTrackConstraints")}} dictionary.

To learn more about how constraints work, see Capabilities, constraints, and settings.

Instance properties

Some combination—but not necessarily all—of the following properties will exist on the object.

  • {{domxref("MediaTrackSupportedConstraints.aspectRatio", "aspectRatio")}}
    • : A Boolean that is true if the aspectRatio constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.autoGainControl", "autoGainControl")}}
    • : A Boolean that is true if the autoGainControl constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.channelCount", "channelCount")}}
    • : A Boolean that is true if the channelCount constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.deviceId", "deviceId")}}
    • : A Boolean that is true if the deviceId constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.echoCancellation", "echoCancellation")}}
    • : A Boolean that is true if the echoCancellation constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.facingMode", "facingMode")}}
    • : A Boolean that is true if the facingMode constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.frameRate", "frameRate")}}
    • : A Boolean that is true if the frameRate constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.groupId", "groupId")}}
    • : A Boolean that is true if the groupId constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.height", "height")}}
    • : A Boolean that is true if the height constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.latency", "latency")}}
    • : A Boolean that is true if the latency constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.noiseSuppression", "noiseSuppression")}}
    • : A Boolean that is true if the noiseSuppression constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.restrictOwnAudio", "restrictOwnAudio")}}
    • : A Boolean that is true if the {{domxref("MediaTrackConstraints.restrictOwnAudio", "restrictOwnAudio")}} constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.resizeMode", "resizeMode")}}
    • : A Boolean that is true if the resizeMode constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.sampleRate", "sampleRate")}}
    • : A Boolean that is true if the sampleRate constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.sampleSize", "sampleSize")}}
    • : A Boolean that is true if the sampleSize constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.suppressLocalAudioPlayback", "suppressLocalAudioPlayback")}}
  • {{domxref("MediaTrackSupportedConstraints.volume", "volume")}} {{Deprecated_Inline}} {{Non-standard_Inline}}
    • : A Boolean that is true if the volume constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.width", "width")}}
    • : A Boolean that is true if the width constraint is supported in the current environment.

Instance properties specific to shared screen tracks

For tracks containing video sources from the user's screen, the following additional properties may be included, in addition to those available for video tracks:

  • {{domxref("MediaTrackSupportedConstraints.displaySurface", "displaySurface")}}
    • : A Boolean that is true if the {{domxref("MediaTrackConstraints.displaySurface", "displaySurface")}} constraint is supported in the current environment.
  • {{domxref("MediaTrackSupportedConstraints.logicalSurface", "logicalSurface")}}
    • : A Boolean that is true if the {{domxref("MediaTrackConstraints.logicalSurface", "logicalSurface")}} constraint is supported in the current environment.

Specifications

{{Specifications}}

See also