HTML <audio> Tag
The HTML <audio>
tag is used to create an 'audio' element, which represents audio embedded into an HTML document.
A common usage of the <audio>
element is to embed music files into a web page but it could be used for other purposes. For example, you could use the <audio>
element to present nature sounds, a voice over narration, a recorded interview, etc.
The <audio>
tag was introduced in HTML 5.
Syntax
The <audio>
tag is written as <audio>
</audio>
with any attributes provided within the start tag. Attributes can specify the actual audio file to play, as well as other options such as whether to play automatically, whether the browser should display the controls or not, etc.
Like this:
Any content between the opening and closing <audio>
tags is fallback content. This content is displayed only by browsers that don't support the <audio>
tag.
Example
This example uses the controls
boolean attribute to tell the browser to display controls (so that the user can play/pause, modify the volume, etc).
Attributes
Attributes can be added to an HTML element to provide more information about how the element should appear or behave.
There are 3 kinds of attributes that you can add to your HTML tags: Element-specific, global, and event handler content attributes.
The <audio>
element accepts the following attributes.
Element-Specific Attributes
This table shows the attributes that are specific to the <audio>
tag/element.
Attribute | Description | ||||||
---|---|---|---|---|---|---|---|
src | Specifies the location of the audio file. Its value must be the URI of an audio file. | ||||||
crossorigin | This attribute is a CORS settings attribute. CORS stands for Cross-Origin Resource Sharing. The purpose of the crossorigin attribute is to allow you to configure the CORS requests for the element's fetched data. The values for the crossorigin attribute are enumerated.
Possible values:
If this attribute is not specified, CORS is not used at all. An invalid keyword and an empty string will be handled as the |
||||||
preload | Specifies whether the audio should be preloaded or not, and if so, how it should be preloaded. This attribute allows the author to provide a hint to the browser/user agent about what the author thinks will lead to the best user experience. This attribute may be ignored in some instances. For example, if the user has disabled preloading or if there are network connectivity issues.
Possible values:
Note that the |
||||||
autoplay | Specifies whether or not to start playing the audio as soon as the object has loaded.
This attribute is a boolean attribute. Therefore, the mere presence of this attribute equates to a true value. You can also specify a value that is a case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace (i.e. either Possible values:
|
||||||
mediagroup | For synchronizing playback of audio files (or media elements). Allows you to specify media elements to link together. The value is a string of text, for example: mediagroup=movie . Audio files/media elements with the same value are automatically linked by the user agent/browser.
An example of where the |
||||||
loop | Specifies whether to keep re-playing the audio once it has finished.
This attribute is a boolean attribute. Therefore, the mere presence of this attribute equates to a true value. You can also specify a value that is a case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace (i.e. either Possible values:
|
||||||
controls | Specifies whether or not to display audio controls (such as a play/pause button etc).
This attribute is a boolean attribute. Therefore, the mere presence of this attribute equates to a true value. You can also specify a value that is a case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace (i.e. either Possible values:
|
Global Attributes
The following attributes are standard across all HTML5 elements. Therefore, you can use these attributes with the <audio>
tag , as well as with all other HTML tags.
- accesskey
- class
- contenteditable
- contextmenu
- dir
- draggable
- dropzone
- hidden
- id
- inert
- itemid
- itemprop
- itemref
- itemscope
- itemtype
- lang
- spellcheck
- style
- tabindex
- title
- translate
For a full explanation of these attributes, see HTML 5 global attributes.
Event Handler Content Attributes
Event handler content attributes enable you to invoke a script from within your HTML. The script is invoked when a certain "event" occurs. Each event handler content attribute deals with a different event.
Below are the standard HTML5 event handler content attributes.
Again, you can use any of these with the <audio>
element, as well as any other HTML5 element.
- onabort
- oncancel
- onblur
- oncanplay
- oncanplaythrough
- onchange
- onclick
- oncontextmenu
- ondblclick
- ondrag
- ondragend
- ondragenter
- ondragexit
- ondragleave
- ondragover
- ondragstart
- ondrop
- ondurationchange
- onemptied
- onended
- onerror
- onfocus
- onformchange
- onforminput
- oninput
- oninvalid
- onkeydown
- onkeypress
- onkeyup
- onload
- onloadeddata
- onloadedmetadata
- onloadstart
- onmousedown
- onmousemove
- onmouseout
- onmouseover
- onmouseup
- onmousewheel
- onpause
- onplay
- onplaying
- onprogress
- onratechange
- onreadystatechange
- onscroll
- onseeked
- onseeking
- onselect
- onshow
- onstalled
- onsubmit
- onsuspend
- ontimeupdate
- onvolumechange
- onwaiting
For a full explanation of these attributes, see HTML 5 event handler content attributes.
Differences Between HTML 4 & HTML 5
The <audio>
element is new in HTML5.
To see more detail on the two versions see HTML5 <audio>
Tag. Also check out the links to the official specifications below.
Template
Here's a template for the <audio>
tag with all available attributes for the tag (based on HTML5). These are grouped into attribute types, each type separated by a space. In many cases, you will probably only need one or two (if any) attributes. Simply remove the attributes you don't need.
For more information on attributes for this tag, see HTML5 <audio>
Tag.
Tag Details
For more details about the <audio>
tag, see HTML5 <audio>
Tag.
Specifications
Here are the official specifications for the <audio>
element.
- HTML5 Specification (W3C)
- HTML Living Standard (WHATWG)
- Current W3C Draft (the next version that is currently being worked on)
What's the Difference?
W3C creates "snapshot" specifications that don't change once defined. So the HTML5 specification won't change once it becomes an official recommendation. WHATWG on the other hand, develops a "living standard" that is updated on a regular basis. In general, you will probably find that the HTML living standard will be more closely aligned to the current W3C draft than to the HTML5 specification.