HTMLAudioElement

The HTMLAudioElement interface provides access to the properties of <audio> elements, as well as methods to manipulate them. It's based on, and inherits properties and methods from, the HTMLMediaElement interface.

Constructor

Audio()
Creates and returns a new HTMLAudioElement object, optionally starting the process of loading an audio file into it if the file URL is given.

Properties

No specific properties; inherits properties from its parent, HTMLMediaElement, and from HTMLElement.

Methods

Inherits methods from its parent, HTMLMediaElement, and from HTMLElement. It offers no methods of its own.

Obsolete Mozilla-only methods

The following methods are non-standard and should not be used.

mozCurrentSampleOffset() This API has not been standardized. This is an obsolete API and is no longer guaranteed to work.
Returns the number of samples form the beginning of the stream that have been written so far into the audio stream created by calling mozWriteAudio().
mozSetup() This API has not been standardized. This is an obsolete API and is no longer guaranteed to work.
Sets up the audio stream to allow writing, given the number of audio channels (1 or 2) and the sample rate in kHz.
mozWriteAudio() This API has not been standardized. This is an obsolete API and is no longer guaranteed to work.
Writes a batch of audio frames to the stream at the current offset, returning the number of bytes actually written to the stream.

Examples

Basic usage

You can create a HTMLAudioElement entirely with JavaScript using the Audio() constructor:

var audioElement = new Audio('car_horn.wav');

then you can invoke the play() method on the element

audioElement.play();

A common gotcha is trying to play an audio element immediately on page load. Modern browser's default autoplay policy will block that from happening. Refer to firefox and chrome for best practices and work arounds.

Some of the more commonly used properties of the audio element include src, currentTime, duration, pausedmuted, and volume. This snippet copies the audio file's duration to a variable:

var audioElement = new Audio('car_horn.wav');
audioElement.addEventListener('loadeddata', () => {
  let duration = audioElement.duration;
  // The duration variable now holds the duration (in seconds) of the audio clip
})

Events

Inherits methods from its parent, HTMLMediaElement, and from its ancestor HTMLElement. Listen to events using addEventListener() or by assigning an event listener to the oneventname property of this interface.

Specifications

Browser compatibility

BCD tables only load in the browser

See also