HTML <audio> Element
The HTML <audio>
tag is used for adding audio to an HTML document. It's commonly used to embed music files into web pages, blogs etc.
The basic tag is written like this <audio src=" controls></audio>
, with the URL of the audio file between the opening and closing tags. The controls
attribute can be used to display the standard audio controls (such as play, pause, volume etc).
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.
The <audio>
tag was introduced in HTML 5.
Example
The following example shows how this element works.
Code
Result
Attributes
The <audio>
element accepts the following attributes.
Local Attributes
The following attributes are defined in the <audio>
element's specification.
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 <audio>
element accepts the following global attributes. These attributes are standard across all HTML 5 elements.
Attribute | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accesskey | Specifies a shortcut key that can be used to access this <audio> element.
Possible values. [Any string of characters. This string of characters specifies the key/s the user needs to use in order to access the element.] |
||||||||||||
class | This is a document wide identifier. It is used to refer to a class that is specified in the style sheet. The value should match the name of the class you wish to use. | ||||||||||||
contenteditable | This attribute specifies whether the user can edit the content or not.
Possible values:
|
||||||||||||
contextmenu | The contextmenu attribute sets a context menu for an element. The value must be the ID of a menu element in the DOM. |
||||||||||||
dir | Specifies the direction of the text.
Possible values:
|
||||||||||||
draggable | Specifies whether the user is allowed to drag this <audio> element or not.
Possible values:
|
||||||||||||
dropzone | The dropzone attribute specifies what should happen when the user "drops" an element (i.e. after dragging it) onto this <audio> element.
Must be an unordered set of unique space-separated tokens that are ASCII case-insensitive. Possible values:
Note that this attribute must not have more than one of the three feedback values (copy, move, and link) specified. If none are specified, the copy value is implied. |
||||||||||||
hidden | Indicates that this particular This is a boolean attribute. If the attribute is present, its value must either be the empty string or a value that is an ASCII case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace (i.e. either Possible values:
|
||||||||||||
id | The id attribute is a document wide identifier, which is used in conjunction with CSS and JavaScript. The value must match the name of the id you wish to use.
|
||||||||||||
itemid | The itemid provides a global identifier for an "item". This attribute is optional, however if it is provided, it must have a value that is a valid URL potentially surrounded by spaces.
The |
||||||||||||
itemprop | This attribute provides one or more properties to one or more "items".
Although this attribute is optional, if used it must have a value that is an unordered set of unique space-separated tokens that are case-sensitive, representing the names of the name-value pairs that it adds. The attribute's value must have at least one token. Each token must be one of the following:
Also, |
||||||||||||
itemref | This attribute is used in conjunction with the |
||||||||||||
itemscope | HTML5 elements that have the itemscope attribute create a name-value pair called an "item". Elements with an itemscope attribute may also have an itemtype attribute specified, to give the item types of the item.
This is a boolean attribute. If the attribute is present, its value must either be the empty string or a value that is an ASCII case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace (i.e. either Possible values:
|
||||||||||||
itemtype | This attribute provides an item type for elements containing the itemscope attribute. The attribute is optional but if it is specified, it must have a value that is an unordered set of unique space-separated tokens that are case-sensitive, each of which is a valid URL that is an absolute URL, and all of which are defined to use the same vocabulary. The attribute's value must have at least one token.
The |
||||||||||||
lang | Sets the language code to be used.
Possible values: [Must be a valid RFC 3066 language code, or an empty string.] |
||||||||||||
spellcheck | Specifies whether the element should have its spelling checked.
If this attribute is missing, the element will use the default behavior, possibly based on the parent's own |
||||||||||||
style | Specifies inline styles for this <audio> element. This allows you to define the styles within the page, and within this <audio> tag, as opposed to referring to styles defined elsewhere (such as an external style sheet). Although this can be useful for over-riding external styles, it is usually preferrable to use external styles in conjunction with the class attribute and/or the id attribute.
|
||||||||||||
tabindex | Helps determine the tabbing order for the element (for when the user uses the "tab" key on their keyboard to "tab" through the elements on the page in order to select an element).
Possible values: [Any valid integer. For example, 0, 1, 2, 3, ...etc] |
||||||||||||
title | Specifies a title to associate with this particular <audio> element. Many browsers will display this when the cursor hovers over the element (similar to a "tool tip").
Possible values: [Any text to be displayed as a "tool tip".] |
||||||||||||
translate | Determines whether the element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.
The
If the |
Event Handlers
This element also accepts various event handlers. Event handlers are commonly used to extend the functionality of an HTML element.
For a list of event handlers that you can use with this element, see Event handlers on elements, Document objects, and Window objects at the W3C website.
More Information About the <audio>
Element
Content Categories | Flow content, Phrasing content, Embedded content. If the element has a controls attribute: Interactive content, palpable content. |
---|---|
Can be used | Where embedded content is expected. |
Content model |
If the element has a src attribute: zero or more <track> elements, then transparent content, but with no media element descendants (i.e. <audio> and <video> ).
If the element does not have a |
End Tag Required? | Yes. Any time you use the <audio> element, it must have both a start tag and an end tag.
|
DOM Interface | HTMLAudioElement |
Specifications for the <audio>
Element
Here is the <audio>
element defined in the various specifications: