AudioTrack: enabled property - Web APIs | MDN (original) (raw)

Limited availability

The AudioTrack property**enabled** specifies whether or not the described audio track is currently enabled for use. If the track is disabled by settingenabled to false, the track is muted and does not produce audio.

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. Settingenabled 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.

js

function swapCommentaryMain() {
  const videoElem = document.getElementById("main-video");
  let audioTrackMain;
  let audioTrackCommentary;

  videoElem.audioTracks.forEach((track) => {
    if (track.kind === "main") {
      audioTrackMain = track;
    } else if (track.kind === "commentary") {
      audioTrackCommentary = track;
    }
  });

  if (audioTrackMain && audioTrackCommentary) {
    const commentaryEnabled = audioTrackCommentary.enabled;
    audioTrackCommentary.enabled = audioTrackMain.enabled;
    audioTrackMain.enabled = commentaryEnabled;
  }
}

The swapCommentaryMain() function above finds within the audio tracks of the element "main-video" the audio tracks whosekind 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 JavaScriptforEach() method (although theaudioTracks 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 thoseAudioTrack 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

Browser compatibility