W3cubDocs

/DOM

MediaTrackConstraints.autoGainControl

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

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

Automatic gain control is typically a feature provided by microphones, although it can be provided by other input sources as well.

Syntax

var constraintsObject = { autoGainControl: constraint };

constraintsObject.autoGainControl = constraint;

Value

If this value is a simple true or false, the user agent will attempt to obtain media with automatic gain control 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 automatic gain control 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

Specification Status Comment
Media Capture and Streams
The definition of 'autoGainControl' in that specification.
Candidate Recommendation Initial specification.

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support Yes ? 55
55
46
Prefixed
Prefixed Requires the vendor prefix: moz
No Yes ?
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support Yes Yes ? 55
55
46
Prefixed
Prefixed Requires the vendor prefix: moz
? ? ?

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/autoGainControl