The AudioTrack
property enabled
specifies whether or not the described audio track is currently enabled for use. If the track is disabled by setting enabled
to false
, the track is muted and does not produce audio.
Syntax
isAudioEnabled = AudioTrack.enabled; AudioTrack.enabled = true | false;
Value
The enabled
property is a Boolean whose value is true
if the track is enabled; enabled tracks produce audio while the media is playing. Setting enabled
to false
effectively mutes the audio track, preventing it from contributing to the media's audio performance.
Example
This example switches between the main and commentary audio tracks of a media element.
function swapCommentaryMain() {
var videoElem = document.getElementById("main-video");
var audioTrackMain;
var audioTrackCommentary;
videoElem.audioTracks.forEach(track) {
if (track.kind === "main") {
audioTrackMain = track;
} else if (track.kind === "commentary") {
audioTrackCommentary = track;
}
}
if (audioTrackMain && audioTrackCommentary) {
var commentaryEnabled = audioTrackCommentary.enabled;
audioTrackCommentary.enabled = audioTrackMain.enabled;
audioTrackMain.enabled = commentaryEnabled;
}
}
The swapCommentaryMain()
function above finds within the audio tracks of the <video>
element "main-video"
the audio tracks whose kind
values are "main"
and "commentary"
. These represent the primary audio track and the commentary track.
Note: This example assumes that there is only one of each kind of track in the video, but this is not necessarily the case.
The element's audio tracks are then scanned through using the JavaScript forEach()
method (although the audioTracks
property of a media element isn't actually a JavaScript array, it can be accessed like one for the most part).
The scan looks for the tracks whose kind
values are "main"
and "commentary"
and remembers those AudioTrack
objects. Once those have been found, the values of the two tracks' enabled
properties are exchanged, which results in swapping which of the two tracks is currently active.
Specifications
Specification | Status | Comment |
---|---|---|
HTML Living StandardThe definition of 'AudioTrack.enabled' in that specification. | Living Standard | |
HTML5The definition of 'AudioTrack.enabled' in that specification. | Recommendation |
Browser compatibility
The compatibility table in 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
enabled
|
Chrome Full support 37 Full support 37 Disabled' From version 37: this feature is behind the |
Edge Full support 79 Full support 79 Disabled' From version 79: this feature is behind the |
Firefox Full support 33 Full support 33 Disabled' From version 33: this feature is behind the |
IE
Full support 10 |
Opera Full support 24 Full support 24 Disabled' From version 24: this feature is behind the |
Safari
Full support 6.1 |
WebView Android
No support No |
Chrome Android Full support 37 Full support 37 Disabled' From version 37: this feature is behind the |
Firefox Android Full support 33 Full support 33 Disabled' From version 33: this feature is behind the |
Opera Android Full support 24 Full support 24 Disabled' From version 24: this feature is behind the |
Safari iOS
Full support 7 |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- User must explicitly enable this feature.'
- User must explicitly enable this feature.
AudioTrack.enabled by Mozilla Contributors is licensed under CC-BY-SA 2.5.