HTML <audio> Tag
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 the <audio>
element in action. You can modify the code (on the left) and click "Refresh" to see your changes take effect (on the right).
Attributes
The <audio>
tag accepts the following attributes. Try adding some to the above example to see how it affects the display/behavior of the element.
Attributes Specific to the <audio>
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 <audio>
tag accepts the following global attributes. These attributes are standard across all HTML 5 tags.
Attribute | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accesskey |
Specifies a shortcut key that can be used to access the 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.] |
||||||||||||||
autocapitalize |
Specifies whether and how text input is automatically capitalized as it is entered/edited by the user.
Possible values:
|
||||||||||||||
class |
Document wide identifier. Used to refer to a class specified in the style sheet. The value should be the name of the class you wish to use. | ||||||||||||||
contenteditable |
Sets whether the user can edit the content or not.
Possible values:
|
||||||||||||||
contextmenu |
Sets a context menu for an element. The value must be the ID of a menu element in the DOM | ||||||||||||||
data-* |
Custom data attribute. The asterisk ( Custom data attributes are intended to store custom data, state, annotations, and similar, private to the page or application, for which there are no more appropriate attributes or elements. |
||||||||||||||
dir |
Specifies the direction of the text.
Possible values:
|
||||||||||||||
draggable |
Specifies whether the user is allowed to drag the element or not.
Possible values:
|
||||||||||||||
dropzone |
Specifies what should happen when the user "drops" an element (i.e. after dragging it) onto the current 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 the element is not yet, or is no longer, relevant. The browser/user agent does not display elements that have the hidden attribute present. 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 |
Document wide identifier. Used with CSS and JavaScript. The value should be the name of the id you wish to use. | ||||||||||||||
inert |
Boolean attribute that indicates that the element is to be made inert. This means that the browser/user agent acts as though the element is not there, even though it may still display the element.
For example, a block of text that has been marked with the 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:
|
||||||||||||||
itemid |
Provides a global identifier for an "item". The itemid attribute is optional, however if it is provided, it must have a value that is a valid URL potentially surrounded by spaces.
The |
||||||||||||||
itemprop |
Provides one or more properties to one or more "items".
Although the
Also, |
||||||||||||||
itemref |
Used in conjunction with the |
||||||||||||||
itemscope |
HTML5 elements that have the 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 |
Provides an item type for elements containing the itemscope attribute. The itemtype attribute is optional however, 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 |
||||||||||||||
slot |
Assigns a slot to an element: an element with a |
||||||||||||||
style |
Specifies inline styles for the element. The value should be the style definition you wish to use. | ||||||||||||||
tabindex |
Helps determine the tabbing order (when the user 'tabs' through the elements on the page).
Possible values: [Any valid integer. For example, 0, 1, 2, 3, ...etc] |
||||||||||||||
title |
Specifies a title to associate with the 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 |
Specifies 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 Handler Content Attributes
An event handler content attribute is an attribute for a specific event handler.
Event handlers are commonly used to extend the functionality of an HTML element. By using event handler content attributes, you can tell the browser to run a specific script and when to run it. For example, by using onclick=""
, you tell the browser to run a script whenever someone clicks on the element.
The HTML specification includes the following event handler content attributes. Most can be used on all HTML elements, but there are exceptions, as outlined below.
Event Handlers for All HTML Elements & document
& window
Objects
The following table lists the event handlers supported by all HTML elements, as both event handler content attributes and event handler IDL attributes; and supported by all Document
and Window
objects, as event handler IDL attributes.
Attribute | Description |
---|---|
onabort |
Invoked when an event has been aborted. For example, the browser stops fetching media data before it is completely downloaded. |
onauxclick |
auxclick event handler. |
oncancel |
cancel event handler. |
oncanplay |
Invoked when the browser/user agent can start playing media, but hasn't yet, due to buffering. In other words, if playback were to begin now, it wouldn't play right to the end (due to the current playback rate) - it would need to pause during playback in order to load the rest of the media. |
oncanplaythrough |
The browser/user agent estimates that if playback were to begin now, the media resource could be rendered at the current playback rate all the way to its end without having to stop for further buffering. |
onchange |
User has changed the object, then attempts to leave that field (i.e. clicks elsewhere). |
onclick |
Invoked when the user clicked on the object. |
onclose |
close event handler. |
oncontextmenu |
Invoked when a context menu has been triggered. |
oncuechange |
cuechange event handler. |
ondblclick |
Invoked when the user clicked twice on the object. |
ondrag |
Invoked when an element is being dragged. |
ondragend |
Invoked when an element has stopped being dragged. |
ondragenter |
Invoked when an element has been dragged to a drop target. |
ondragexit |
dragexit event handler. |
ondragleave |
Invoked when an element leaves a valid drop target. |
ondragover |
Invoked when an element is being dragged over a valid drop target. |
ondragstart |
Invoked when a drag operation has started. |
ondrop |
Invoked when an element is being dropped. |
ondurationchange |
Invoked when the length of the media is changed (i.e. the duration attribute has just been updated). |
onemptied |
Invoked when a media resource element suddenly becomes empty (for example, due to a network error). |
onended |
Invoked when the media has reached the end. |
onformdata |
formdata event handler. |
oninput |
input event handler. |
oninvalid |
invalid event handler. |
onkeydown |
Invoked when a key was pressed over an element. |
onkeypress |
Invoked when a key was pressed over an element then released. |
onkeyup |
Invoked when a key was released over an element. |
onloadeddata |
Invoked when the browser/user agent can render the media data at the current playback position for the first time. |
onloadedmetadata |
Invoked when the browser/user agent has just determined the duration and dimensions of the media resource. |
onloadstart |
Invoked when the browser/user agent has started loading the media resource. |
onmousedown |
The cursor moved over the object and mouse/pointing device was pressed down. |
onmouseenter |
mouseenter event handler. |
onmouseleave |
mouseleave event handler. |
onmousemove |
The cursor moved while hovering over an object. |
onmouseout |
The cursor moved off the object |
onmouseover |
The cursor moved over the object (i.e. user hovers the mouse over the object). |
onmouseup |
The mouse/pointing device was released after being pressed down. |
onpause |
Invoked when the media resource has been paused. |
onplay |
Invoked when the media resource starts playback. |
onplaying |
Playback has begun. |
onprogress |
The browser/user agent is fetching media data the. |
onratechange |
Invoked when the playback rate has changed (i.e. either the defaultPlaybackRate or the playbackRate has just been updated). |
onreset |
reset event handler. |
onsecuritypolicyviolation |
securitypolicyviolation event handler. |
onseeked |
Invoked when the seeking IDL attribute changed to false (i.e. the seeking attribute is no longer true) |
onseeking |
Invoked when the seeking IDL attribute changed to true and the seek operation is taking long enough that the user agent has time to fire the event. |
onselect |
Invoked when some or all of the contents of an object is selected. For example, the user selected some text within a text field. |
onslotchange |
slotchange event handler. |
onstalled |
Invoked when the browser/user agent is trying to fetch media data but the data has stalled (i.e. the data has stopped coming). |
onsubmit |
User submitted a form. |
onsuspend |
The browser/user agent is (intentionally) not currently fetching media data, but has not yet downloaded the entire media resource (i.e. it has suspended the download). |
ontimeupdate |
Invoked when the media's current playback position changed. |
ontoggle |
toggle event handler. |
onvolumechange |
Invoked when either the volume attribute or the muted attribute has changed. |
onwaiting |
The next frame of the media is not yet available (but the browser/user agent expects it to become available). |
onwebkitanimationend |
webkitanimationend event handler. |
onwebkitanimationiteration |
webkitAnimationIteration event handler. |
onwebkitanimationstart |
webkitAnimationStart event handler. |
onwebkittransitionend |
webkitTransitionEnd event handler. |
onwheel |
wheel event handler. |
The following table lists the event handlers (and their corresponding event handler event types) supported by all HTML elements other than body
and frameset
elements, as both event handler content attributes and event handler IDL attributes; supported by all Document
objects, as event handler IDL attributes; and supported by all Window
objects, as event handler IDL attributes on the Window
objects themselves, and with corresponding event handler content attributes and event handler IDL attributes exposed on all body
and frameset
elements that are owned by that Window
object's associated Document
.
Attribute | Description |
---|---|
onblur |
User has left the focus of the element. |
onerror |
Invoked when an error occurs while the Window object is being loaded. Also handler for script error notifications. |
onfocus |
Invoked when the focus is on the element. |
onload |
The element has loaded. |
onresize |
The viewport has been resized. |
onscroll |
scroll event handler. Invoked when the element's scrollbar is being scrolled. |
The following table lists the event handlers supported by Window
objects, as event handler IDL attributes on the Window
objects themselves, and with corresponding event handler content attributes and event handler IDL attributes exposed on all body
and frameset
elements that are owned by that Window
object's associated Document
.
Attribute | Description |
---|---|
onafterprint |
afterprint event handler |
onbeforeprint |
beforeprint event handler |
onbeforeunload |
beforeunload event handler |
onhashchange |
hashchange event handler. The hashchange event is fired when navigating to a session history entry whose URL differs from that of the previous one only in the fragment identifier. |
onlanguagechange |
languagechange event handler. |
onmessage |
message event handler. |
onmessageerror |
messageerror event handler. |
onoffline |
offline event handler. |
ononline |
online event handler. |
onpagehide |
pagehide event handler. The pagehide event is fired when traversing from a session history entry. |
onpageshow |
pageshow event handler. The pageshow event is fired when traversing to a session history entry. |
onpopstate |
popstate event handler. The popstate event is fired when navigating to a session history entry that represents a state object. |
onrejectionhandled |
rejectionhandled event handler. |
onstorage |
storage event handler. |
onunhandledrejection |
unhandledrejection event handler. |
onunload |
unload event handler. |
The following are the event handlers supported by all HTML elements, as both event handler content attributes and event handler IDL attributes; and supported by all Document
objects, as event handler IDL attributes:
Attribute | Description |
---|---|
oncut |
cut event handler. |
oncopy |
copy event handler. |
onpaste |
paste event handler. |
The following event handler is supported on Document
objects as an event handler IDL attribute.
Attribute | Description |
---|---|
onreadystatechange |
readystatechange event handler. |