Web/API/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 StreamsThe definition of 'autoGainControl' in that specification.	Candidate Recommendation	Initial specification.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`autoGainControl`	Chrome Full support Yes	Edge Full support ≤79	Firefox Full support 55 Full support 55 Full support 46 Prefixed' Prefixed' Implemented with the vendor prefix: moz	IE No support No	Opera Full support Yes	Safari ?	WebView Android Full support Yes	Chrome Android Full support Yes	Firefox Android Full support 55 Full support 55 Full support 46 Prefixed' Prefixed' Implemented with the vendor prefix: moz	Opera Android ?	Safari iOS ?	Samsung Internet Android Full support Yes

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Requires a vendor prefix or different name for use.': Requires a vendor prefix or different name for use.