The HTMLMediaElement interface adds to HTMLElement the properties and methods needed to support basic media-related capabilities that are common to audio and video. The HTMLVideoElement and HTMLAudioElement elements both inherit this interface.

Properties

This interface also inherits properties from its ancestors HTMLElement, Element, Node, and EventTarget.

HTMLMediaElement.audioTracks
A AudioTrackList that lists the AudioTrack objects contained in the element.
HTMLMediaElement.autoplay
A Boolean that reflects the autoplay HTML attribute, indicating whether playback should automatically begin as soon as enough media is available to do so without interruption.
Sites which automatically play audio (or videos with an audio track) can be an unpleasant experience for users, so it should be avoided when possible. If you must offer autoplay functionality, you should make it opt-in (requiring a user to specifically enable it). However, this can be useful when creating media elements whose source will be set at a later time, under user control.
HTMLMediaElement.buffered Read only
Returns a TimeRanges object that indicates the ranges of the media source that the browser has buffered (if any) at the moment the buffered property is accessed.
HTMLMediaElement.controller
Is a MediaController object that represents the media controller assigned to the element, or null if none is assigned.
HTMLMediaElement.controls
Is a Boolean that reflects the controls HTML attribute, indicating whether user interface items for controlling the resource should be displayed.
HTMLMediaElement.controlsList Read only
Returns a DOMTokenList that helps the user agent select what controls to show on the media element whenever the user agent shows its own set of controls. The DOMTokenList takes one or more of three possible values: nodownload, nofullscreen, and noremoteplayback.
HTMLMediaElement.crossOrigin
Is a DOMString indicating the CORS setting for this media element.
HTMLMediaElement.currentSrc Read only
Returns a DOMString with the absolute URL of the chosen media resource.
HTMLMediaElement.currentTime
Is a double indicating the current playback time in seconds. Setting this value seeks the media to the new time.
HTMLMediaElement.defaultMuted
Is a Boolean that reflects the muted HTML attribute, which indicates whether the media element's audio output should be muted by default.
HTMLMediaElement.defaultPlaybackRate
Is a double indicating the default playback rate for the media.
HTMLMediaElement.disableRemotePlayback
Is a Boolean that sets or returns the remote playback state, indicating whether the media element is allowed to have a remote playback UI.
HTMLMediaElement.duration Read only
Returns a double indicating the length of the media in seconds, or 0 if no media data is available.
HTMLMediaElement.ended Read only
Returns a Boolean that indicates whether the media element has finished playing.
HTMLMediaElement.error Read only
Returns a MediaError object for the most recent error, or null if there has not been an error.
HTMLMediaElement.loop
Is a Boolean that reflects the loop HTML attribute, which indicates whether the media element should start over when it reaches the end.
HTMLMediaElement.mediaGroup
Is a DOMString that reflects the mediagroup HTML attribute, which indicates the name of the group of elements it belongs to. A group of media elements shares a common MediaController.
HTMLMediaElement.mediaKeys Read only
Returns a MediaKeys object or null. MediaKeys is a set of keys that an associated HTMLMediaElement can use for decryption of media data during playback.
HTMLMediaElement.mozAudioCaptured Read only
Returns a Boolean. Related to audio stream capture.
HTMLMediaElement.mozFragmentEnd
Is a double that provides access to the fragment end time if the media element has a fragment URI for currentSrc, otherwise it is equal to the media duration.
HTMLMediaElement.mozFrameBufferLength  

Is a unsigned long that indicates the number of samples that will be returned in the framebuffer of each MozAudioAvailable event. This number is a total for all channels, and by default is set to be the number of channels * 1024 (e.g., 2 channels * 1024 samples = 2048 total).

The mozFrameBufferLength property can be set to a new value for lower latency, larger amounts of data, etc. The size given must be a number between 512 and 16384. Using any other size results in an exception being thrown. The best time to set a new length is after the loadedmetadata event fires, when the audio info is known, but before the audio has started or MozAudioAvailable events have begun firing.

HTMLMediaElement.mozSampleRate Read only  
Returns a double representing the number of samples per second that will be played. For example, 44100 samples per second is the sample rate used by CD audio.
HTMLMediaElement.muted
Is a Boolean that determines whether audio is muted. true if the audio is muted and false otherwise.
HTMLMediaElement.networkState Read only
Returns a unsigned short (enumeration) indicating the current state of fetching the media over the network.
HTMLMediaElement.paused Read only
Returns a Boolean that indicates whether the media element is paused.
HTMLMediaElement.playbackRate
Is a double that indicates the rate at which the media is being played back. 
HTMLMediaElement.played Read only
Returns a TimeRanges object that contains the ranges of the media source that the browser has played, if any.
HTMLMediaElement.preload
Is a DOMString that reflects the preload HTML attribute, indicating what data should be preloaded, if any. Possible values are: none, metadata, auto.
HTMLMediaElement.preservesPitch
Is a Boolean that determines if the pitch of the sound will be preserved. If set to false, the pitch will adjust to the speed of the audio. This is implemented with prefixes in Firefox (mozPreservesPitch) and WebKit (webkitPreservesPitch).
HTMLMediaElement.readyState Read only
Returns a unsigned short (enumeration) indicating the readiness state of the media.
HTMLMediaElement.seekable Read only
Returns a TimeRanges object that contains the time ranges that the user is able to seek to, if any.
HTMLMediaElement.seeking Read only
Returns a Boolean that indicates whether the media is in the process of seeking to a new position.
HTMLMediaElement.sinkId Read only
Returns a DOMString that is the unique ID of the audio device delivering output, or an empty string if it is using the user agent default. This ID should be one of the MediaDeviceInfo.deviceid values returned from MediaDevices.enumerateDevices(), id-multimedia, or id-communications.
HTMLMediaElement.src
Is a DOMString that reflects the src HTML attribute, which contains the URL of a media resource to use.
HTMLMediaElement.srcObject
Is a MediaStream representing the media to play or that has played in the current HTMLMediaElement, or null if not assigned.
HTMLMediaElement.textTracks Read only
Returns the list of TextTrack objects contained in the element.
HTMLMediaElement.videoTracks Read only
Returns the list of VideoTrack objects contained in the element.

Gecko supports only single track playback, and the parsing of tracks' metadata is only available for media with the Ogg container format.

HTMLMediaElement.volume
Is a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).

Event handlers

 
HTMLMediaElement.onencrypted
Sets the EventHandler called when the media is encrypted.
HTMLMediaElement.onwaitingforkey
Sets the EventHandler called when playback is blocked while waiting for an encryption key.

Obsolete attributes

These attributes are obsolete and should not be used, even if a browser still supports them.

 

HTMLMediaElement.initialTime Read only
Returns a double that indicates the initial playback position in seconds.
HTMLMediaElement.mozChannels Read only  
Returns a double representing the number of channels in the audio resource (e.g., 2 for stereo).

Obsolete event handlers

 

HTMLMediaElement.onmozinterruptbegin
Sets the EventHandler called when the media element is interrupted because of the Audio Channel manager. This was Firefox-specific, having been implemented for Firefox OS, and was removed in Firefox 55.
HTMLMediaElement.onmozinterruptend
Sets the EventHandler called when the interruption is concluded. This was Firefox-specific, having been implemented for Firefox OS, and was removed in Firefox 55.

 

 

Methods

This interface also inherits methods from its ancestors HTMLElement, Element, Node, and EventTarget.

HTMLMediaElement.addTextTrack()
Adds a text track (such as a track for subtitles) to a media element.
HTMLMediaElement.captureStream()
Returns MediaStream, captures a stream of the media content.
HTMLMediaElement.canPlayType()
Determines whether the specified media type can be played back.
HTMLMediaElement.fastSeek()
Directly seeks to the given time.
HTMLMediaElement.load()
Resets the media element and restarts the media resource. Any pending events are discarded. How much media data is fetched is still affected by the preload attribute. This method can be useful for releasing resources after any src attribute and source element descendants have been removed. Otherwise, it is usually unnecessary to use this method, unless required to rescan source element children after dynamic changes.
HTMLMediaElement.mozCaptureStream()
[enter description]
HTMLMediaElement.mozCaptureStreamUntilEnded()
[enter description]
HTMLMediaElement.mozGetMetadata()
Returns Object, which contains properties that represent metadata from the playing media resource as {key: value} pairs. A separate copy of the data is returned each time the method is called. This method must be called after the loadedmetadata event fires.
HTMLMediaElement.pause()
Pauses the media playback.
HTMLMediaElement.play()
Begins playback of the media.
HTMLMediaElement.seekToNextFrame()
Seeks to the next frame in the media. This non-standard, experimental method makes it possible to manually drive reading and rendering of media at a custom speed, or to move through the media frame-by-frame to perform filtering or other operations.
HTMLMediaElement.setMediaKeys()
Returns Promise. Sets the MediaKeys keys to use when decrypting media during playback.
HTMLMediaElement.setSinkId()
Sets the ID of the audio device to use for output and returns a Promise. This only works when the application is authorized to use the specified device.

Obsolete methods

These methods are obsolete and should not be used, even if a browser still supports them.

 

HTMLMediaElement.mozLoadFrom()
This method, available only in Mozilla's implementation, loads data from another media element. This works similarly to load() except that instead of running the normal resource selection algorithm, the source is simply set to the other element's currentSrc. This is optimized so this element gets access to all of the other element's cached and buffered data; in fact, the two elements share downloaded data, so data downloaded by either element is available to both.

 

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'HTMLMediaElement' in that specification.
Living Standard No change from HTML5
HTML5
The definition of 'HTMLMediaElement' in that specification.
Recommendation Initial definition.
Encrypted Media Extensions
The definition of 'Encrypted Media Extensions' in that specification.
Recommendation Adds MediaKeys, MediaEncryptedEvent, setMediaKeys, onencrypted, and onwaitingforkey.
Media Capture and Streams
The definition of 'HTMLMediaElement' in that specification.
Candidate Recommendation Adds sinkId and setSinkId(), and captureStream().

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support Yes Yes3.59 Yes Yes
addTextTrack ? ? ? ? ? ?
audioTracks ? No331 ? ? ?
autoplay Yes Yes3.59 Yes Yes
buffered Yes Yes49 Yes Yes
canPlayType Yes Yes3.59 Yes Yes
captureStream53 No15 moz No ? No
controller ? No No2 ? ? ?
controls Yes Yes3.59 Yes Yes
controlsList58 ? ? ?45 ?
crossOrigin Yes Yes

22

12 — 223

9 Yes Yes
currentSrc Yes Yes3.59 Yes Yes
currentTime Yes Yes3.59 Yes Yes
defaultMuted Yes Yes11 ? Yes Yes
defaultPlaybackRate Yes Yes209 ? ?
disableRemotePlayback49 Yes209 Yes Yes
duration Yes Yes3.59 Yes Yes
ended Yes Yes3.59 Yes Yes
error Yes Yes3.59 Yes Yes
fastSeek ? No31 ? ? ?
initialTime ? No9 — 23 ? ? ?
load ? ? ? ? ? ?
loop Yes Yes119 ? ?
mediaGroup ? No No2 ? ? ?
mediaKeys ? ? ? ? ? ?
mozAudioCaptured ? ? ? ? ? ?
mozCaptureStreamUntilEnded ? ? ? ? ? ?
mozChannels No No4 No No No
mozFragmentEnd ? ? ? ? ? ?
mozFrameBufferLength No No4 No No No
mozGetMetadata No No17 No No No
mozLoadFrom No No3.6 — 24 No No No
mozSampleRate No No4 No No No
muted Yes Yes3.59 Yes Yes
networkState Yes Yes3.549 Yes Yes
onerror Yes Yes3.59 Yes Yes
onencrypted ? ? ? ? ? ?
onmozinterruptbegin ? ? Yes — 55 ? ? ?
onmozinterruptend ? ? Yes — 55 ? ? ?
onwaitingforkey55 No ? ?42 ?
pause Yes Yes3.59 Yes Yes
paused Yes Yes3.59 Yes Yes
play Yes Yes3.59 Yes Yes
playbackRate Yes Yes209 ? ?
played Yes Yes159 ? ?
preload Yes Yes49 ? ?
preservesPitch Yes -webkit- No20 -moz- No No No
readyState Yes Yes3.59 Yes Yes
seekToNextFrame ? No495 ? ? ?
seekable Yes Yes89 ? ?
seeking Yes Yes3.59 Yes Yes
setMediaKeys ? ? ? ? ? ?
setSinkId4917 ? ? ? ?
sinkId4917 ? ? ? ?
src Yes Yes3.59 Yes Yes
srcObject52 Yes

Yes

18 — 58 moz

?39 ?
textTracks ? No ? ? ? ?
videoTracks ? No331 ? ? ?
volume Yes Yes3.59 Yes Yes
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes Yes Yes Yes Yes Yes ?
addTextTrack ? ? ? ? ? ? ?
audioTracks ? ? Yes331 ? ? ?
autoplay Yes Yes Yes Yes Yes Yes ?
buffered Yes Yes Yes Yes Yes Yes ?
canPlayType Yes Yes Yes Yes Yes Yes ?
captureStream5353 No15 moz ? No ?
controller ? ? No No2 ? ? ?
controls Yes Yes Yes Yes Yes Yes ?
controlsList5858 ? ?42 ? ?
crossOrigin Yes Yes Yes Yes Yes Yes ?
currentSrc Yes Yes Yes Yes Yes Yes ?
currentTime Yes Yes Yes Yes Yes Yes ?
defaultMuted Yes Yes Yes14 Yes Yes ?
defaultPlaybackRate Yes Yes Yes20 ? ? ?
disableRemotePlayback4949 Yes15 Yes Yes ?
duration Yes Yes Yes Yes Yes Yes ?
ended Yes Yes Yes Yes Yes Yes ?
error Yes Yes Yes Yes Yes Yes ?
fastSeek ? ? No31 ? ? ?
initialTime ? ? No9 — 23 ? ? ?
load ? ? ? ? ? ? ?
loop Yes Yes Yes Yes ? ? ?
mediaGroup ? ? No No2 ? ? ?
mediaKeys ? ? ? ? ? ? ?
mozAudioCaptured ? ? ? ? ? ? ?
mozCaptureStreamUntilEnded ? ? ? ? ? ? ?
mozChannels No No No4 No No ?
mozFragmentEnd ? ? ? ? ? ? ?
mozFrameBufferLength No No No4 No No ?
mozGetMetadata No No No17 No No ?
mozLoadFrom No No No4 — 24 No No ?
mozSampleRate No No No4 No No ?
muted Yes Yes Yes Yes Yes Yes ?
networkState Yes Yes Yes Yes Yes Yes ?
onerror Yes Yes Yes Yes Yes Yes ?
onencrypted ? ? ? ? ? ? ?
onmozinterruptbegin ? ? ? Yes — 55 ? ? ?
onmozinterruptend ? ? ? Yes — 55 ? ? ?
onwaitingforkey5555 No ?42 ? ?
pause Yes Yes Yes Yes Yes Yes ?
paused Yes Yes Yes Yes Yes Yes ?
play Yes Yes Yes Yes Yes Yes ?
playbackRate Yes Yes Yes20 ? ? ?
played Yes Yes Yes15 ? ? ?
preload Yes Yes Yes4 ? ? ?
preservesPitch Yes Yes Yes Yes No No ?
readyState Yes Yes Yes Yes Yes Yes ?
seekToNextFrame ? ? No495 ? ? ?
seekable Yes Yes Yes8 ? ? ?
seeking Yes Yes Yes Yes Yes Yes ?
setMediaKeys ? ? ? ? ? ? ?
setSinkId494917 ? ? ? ?
sinkId494917 ? ? ? ?
src Yes Yes Yes Yes Yes Yes ?
srcObject5252 Yes

Yes

18 — 58 moz

39 ? ?
textTracks ? ? No ? ? ? ?
videoTracks ? ? Yes331 ? ? ?
volume Yes Yes Yes Yes Yes Yes ?

1. From version 33: this feature is behind the media.track.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

2. Firefox doesn't implement this yet. See bug 847377.

3. Supported as crossorigin.

4. The NETWORK_LOADED state was removed to align with the HTML spec in Firefox 4.

5. From version 49: this feature is behind the media.seekToNextFrame preference (needs to be set to true). To change preferences in Firefox, visit about:config.

See also