The MediaTrackSettings dictionary's autoGainControl property is a Boolean value whose value indicates whether or not automatic gain control (AGC) is enabled on an audio track. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.autoGainControl property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().
Automatic gain control is a feature in which a sound source automatically manages changes in the volume of its source media to maintain a steady overall volume level. This feature is typically used on microphones, although it can be provided by other input sources as well.
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.
Syntax
var autoGainControl = MediaTrackSettings.autoGainControl;
Value
A Boolean value which is true if the track has automatic gain control enabled or false if AGC is disabled.
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
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
autoGainControl
|
Chrome
Full support Yes |
Edge
Full support ≤79 |
Firefox Full support 55 Full support 55 No support 50 — 55 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 No support 50 — 55 Prefixed' Implemented with the vendor prefix: moz |
Opera Android
Full support Yes |
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.
See also
- Media Capture and Streams API
- Capabilities, constraints, and settings
MediaTrackConstraints.autoGainControlMediaTrackSupportedConstraints
MediaTrackSettings.autoGainControl by Mozilla Contributors is licensed under CC-BY-SA 2.5.