MediaTrackConstraints.noiseSuppression

The MediaTrackConstraints dictionary's noiseSuppression property is a ConstrainBoolean describing the requested or mandatory constraints placed upon the value of the noiseSuppression constrainable property.

If needed, you can determine whether or not this constraint is supported by checking the value of MediaTrackSupportedConstraints.noiseSuppression as returned by a call to MediaDevices.getSupportedConstraints(). However, typically this is unnecessary since browsers will simply ignore any constraints they're unfamiliar with.

Noise suppression is typically provided by microphones, although it can be provided by other input sources as well.

Syntax

var constraintsObject = { noiseSuppression: constraint };

constraintsObject.noiseSuppression = constraint;

Value

If this value is a simple true or false, the user agent will attempt to obtain media with noise suppression enabled or disabled as specified, if possible, but will not fail if this can't be done. If, instead, the value is given as an object with an exact field, that field's Boolean value indicates a required setting for the noise suppression feature; if it can't be met, then the request will result in an error.

Example

See Example: Constraint exerciser in Capabilities, constraints, and settings for an example.

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• Media Capture and Streams API
• Capabilities, constraints, and settings
• MediaTrackConstraints
• MediaDevices.getSupportedConstraints()
• MediaTrackSupportedConstraints
• MediaStreamTrack