Summary

The audio element is used to embed sound content in an HTML or XHTML document.  The audio element was added as part of HTML5.

You can use the enhanced audio API features — which are Gecko-specific — to directly generate and manipulate audio streams from JavaScript code. See Introducing the audio API extension for details.

Usage Context

Attributes

Like all other HTML elements, this element supports the global attributes.

autoplay

A Boolean attribute; if specified (even if the value is "false"!), the audio will automatically begin to play back as soon as it can do so without stopping to finish loading the data.

autobuffer Obsolete since Gecko 2.0

A Boolean attribute; if specified, the audio will automatically begin being downloaded, even if not set to automatically play. This continues until the media cache is full, or the entire audio file has been downloaded, whichever comes first. This should only be used when it is expected that the user will choose to play the audio; for example, if the user has navigated to a page using a "Play this audio" link. This attribute was removed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1) in favor of the preload attribute.

buffered

An attribute you can read to determine which time ranges of the media have been buffered. This attribute contains a TimeRanges object.

controls

If this attribute is present, the browser will offer controls to allow the user to control audio playback, including volume, seeking, and pause/resume playback.

loop

A Boolean attribute; if specified, we will, upon reaching the end of the audio, automatically seek back to the start.

mozCurrentSampleOffset Requires Gecko 2.0 Non-standard

The offset, specified as the number of samples since the beginning of the audio stream, at which the audio is currently playing.

preload

This enumerated attribute is intended to provide a hint to the browser about what the author thinks will lead to the best user experience. It may have one of the following values:

• none: hints that either the author thinks that the user won't need to consult that video or that the server wants to minimize its traffic; in others terms this hint indicates that the video should not be cached;
• metadata: hints that though the author thinks that the user won't need to consult that video, fetching the metadata (e.g. length) is reasonable;
• auto: hints that the user needs have priority; in others terms this hint indicated that, if needed, the whole video could be downloaded, even if the user is not expected to use it;
• the empty string: which is a synonym of the auto value.

If not set, its default value is browser-defined (i.e. each browser can choose its own default value), though the spec advises it to be set to metadata.

Usage notes:

• The autoplay attribute has precedence over this one as if one wants to automatically play a video, the browser will obviously need to download it. Setting both the autoplay and the preload attributes is allowed by the specification.
• The browser is not forced by the specification to follow the value of this attribute; it is a mere hint.

src

The URL of the audio to embed. This is subject to HTTP access controls. This is optional; you may instead use the source element within the audio block to specify the audio to embed.

Time offsets are specified as float values indicating the number of seconds to offset.

Examples

<!-- Simple audio playback -->
<audio src="http://developer.mozilla.org/@api/deki/files/2926/=AudioTest_(1).ogg" autoplay>
  Your browser does not support the <code>audio</code> element.
</audio>

<!-- Audio playback with captions -->
<audio src="foo.ogg">
  <track kind="captions" src="foo.en.vtt" srclang="en" label="English">
  <track kind="captions" src="foo.sv.vtt" srclang="sv" label="Svenska">
</audio>

Plays the audio file attached to this article.

DOM Interface

• HTMLAudioElement

Compatibility

See also

• Media formats supported by the audio and video elements
• Introducing the audio API extension
• HTMLAudioElement
• nsIDOMHTMLMediaElement
• video
• Using audio and video in Firefox
• The audio element (HTML5 specification)