HTMLMediaElement
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 theAudioTrack
objects contained in the element. HTMLMediaElement.autoplay
-
A boolean value that reflects the
autoplay
HTML attribute, indicating whether playback should automatically begin as soon as enough media is available to do so without interruption.Note: Automatically playing audio when the user doesn't expect or desire it is a poor user experience and should be avoided in most cases, though there are exceptions. See the Autoplay guide for media and Web Audio APIs for more information. Keep in mind that browsers may ignore autoplay requests, so you should ensure that your code isn't dependent on autoplay working.
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 thebuffered
property is accessed. HTMLMediaElement.controller
-
Is a
MediaController
object that represents the media controller assigned to the element, ornull
if none is assigned. HTMLMediaElement.controls
-
Is a
Boolean
that reflects thecontrols
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. TheDOMTokenList
takes one or more of three possible values:nodownload
,nofullscreen
, andnoremoteplayback
. HTMLMediaElement.crossOrigin
-
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
-
A double-precision floating-point value indicating the current playback time in seconds; if the media has not started to play and has not been seeked, this value is the media's initial playback time. Setting this value seeks the media to the new time. The time is specified relative to the media's timeline.
HTMLMediaElement.defaultMuted
-
A
Boolean
that reflects themuted
HTML attribute, which indicates whether the media element's audio output should be muted by default. HTMLMediaElement.defaultPlaybackRate
-
A
double
indicating the default playback rate for the media. HTMLMediaElement.disableRemotePlayback
-
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-
A read-only double-precision floating-point value indicating the total duration of the media in seconds. If no media data is available, the returned value is
NaN
. If the media is of indefinite length (such as streamed live media, a WebRTC call's media, or similar), the value is+Infinity
. 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, ornull
if there has not been an error. HTMLMediaElement.loop
-
A
Boolean
that reflects theloop
HTML attribute, which indicates whether the media element should start over when it reaches the end. HTMLMediaElement.mediaKeys
Read only-
Returns a
MediaKeys
object ornull
. MediaKeys is a set of keys that an associated HTMLMediaElement can use for decryption of media data during playback. HTMLMediaElement.muted
-
Is a
Boolean
that determines whether audio is muted.true
if the audio is muted andfalse
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 thepreload
HTML attribute, indicating what data should be preloaded, if any. Possible values are:none
,metadata
,auto
. HTMLMediaElement.preservesPitch
-
Is a boolean value 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. 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 theMediaDeviceInfo.deviceid
values returned fromMediaDevices.enumerateDevices()
,id-multimedia
, orid-communications
. HTMLMediaElement.src
-
Is a
DOMString
that reflects thesrc
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 currentHTMLMediaElement
, ornull
if not assigned. HTMLMediaElement.textTracks
Read only-
Returns a
TextTrackList
object containing the list ofTextTrack
objects contained in the element. HTMLMediaElement.videoTracks
Read only-
Returns a
VideoTrackList
object containing the list ofVideoTrack
objects contained in the element. HTMLMediaElement.volume
-
Is a
double
indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).
Event handlers
HTMLMediaElement.onencrypted
-
Sets the event handler called when the media is encrypted.
HTMLMediaElement.onwaitingforkey
-
Sets the event handler called when playback is blocked while waiting for an encryption key.
Obsolete properties
These properties are obsolete and should not be used, even if a browser still supports them.
HTMLMediaElement.mediaGroup
-
A
DOMString
that reflects themediagroup
HTML attribute, which indicates the name of the group of elements it belongs to. A group of media elements shares a commonMediaController
. 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 forcurrentSrc
, otherwise it is equal to the media duration.
Methods
This interface also inherits methods from its ancestors HTMLElement
, Element
, Node
, and EventTarget
.
HTMLMediaElement.addTextTrack()
-
Adds a new
TextTrack
object (such as a track for subtitles) to a media element. This is a programmatic interface only and does not affect the DOM. HTMLMediaElement.captureStream()
-
Returns
MediaStream
, captures a stream of the media content. HTMLMediaElement.canPlayType()
-
Given a string specifying a MIME media type (potentially with the
codecs
parameter included),canPlayType()
returns the stringprobably
if the media should be playable,maybe
if there's not enough information to determine whether the media will play or not, or an empty string if the media cannot be played. HTMLMediaElement.fastSeek()
-
Quickly seeks to the given time with low precision.
HTMLMediaElement.load()
-
Resets the media to the beginning and selects the best available source from the sources provided using the
src
attribute or the<source>
element. 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 theMediaKeys
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.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.
Events
Inherits methods from its parent, HTMLElement
, defined in the GlobalEventHandlers
mixin. Listen to these events using addEventListener()
or by assigning an event listener to the oneventname
property of this interface.
abort
-
Fired when the resource was not fully loaded, but not as the result of an error.
canplay
-
Fired when the user agent can play the media, but estimates that not enough data has been loaded to play the media up to its end without having to stop for further buffering of content
canplaythrough
-
Fired when the user agent can play the media, and estimates that enough data has been loaded to play the media up to its end without having to stop for further buffering of content.
durationchange
-
Fired when the duration property has been updated.
emptied
-
Fired when the media has become empty; for example, when the media has already been loaded (or partially loaded), and the
HTMLMediaElement.load()
method is called to reload it. ended
-
Fired when playback stops when end of the media (<audio> or <video>) is reached or because no further data is available.
error
-
Fired when the resource could not be loaded due to an error.
loadeddata
-
Fired when the first frame of the media has finished loading.
loadedmetadata
-
Fired when the metadata has been loaded
loadstart
-
Fired when the browser has started to load a resource.
pause
-
Fired when a request to pause play is handled and the activity has entered its paused state, most commonly occurring when the media's
HTMLMediaElement.pause()
method is called. play
-
Fired when the
paused
property is changed fromtrue
tofalse
, as a result of theHTMLMediaElement.play()
method, or theautoplay
attribute playing
-
Fired when playback is ready to start after having been paused or delayed due to lack of data
progress
-
Fired periodically as the browser loads a resource.
ratechange
-
Fired when the playback rate has changed.
resize
-
Fired when one or both of the
videoWidth
andvideoHeight
properties have just been updated. seeked
-
Fired when a seek operation completes
seeking
-
Fired when a seek operation begins
stalled
-
Fired when the user agent is trying to fetch media data, but data is unexpectedly not forthcoming.
suspend
-
Fired when the media data loading has been suspended.
timeupdate
-
Fired when the time indicated by the
currentTime
property has been updated. volumechange
-
Fired when the volume has changed.
waiting
-
Fired when playback has stopped because of a temporary lack of data.
Specifications
Specification |
---|
HTML Standard # htmlmediaelement |
Browser compatibility
BCD tables only load in the browser
See also
References
<video>
and<audio>
HTML elements.HTMLVideoElement
andHTMLAudioElement
interfaces, derived fromHTMLMediaElement
.