Baseline Widely available *
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.
This interface also inherits properties from its ancestors HTMLElement
, Element
, Node
, and EventTarget
.
HTMLMediaElement.audioTracks
An AudioTrackList
that lists the AudioTrack
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 the buffered
property is accessed.
HTMLMediaElement.controls
A boolean that reflects the controls
HTML attribute, indicating whether user interface items for controlling the resource should be displayed.
HTMLMediaElement.controlsList
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
A string indicating the CORS setting for this media element.
HTMLMediaElement.currentSrc
Read only
Returns a string 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 the muted
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, or null
if there has not been an error.
HTMLMediaElement.loop
A boolean that reflects the loop
HTML attribute, which indicates whether the media element should start over when it reaches the end.
HTMLMediaElement.mediaKeys
Read only Secure context
Returns a MediaKeys
object, that is a set of keys that the element can use for decryption of media data during playback. If no key is available, it can be null
.
HTMLMediaElement.muted
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
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
A string that reflects the preload
HTML attribute, indicating what data should be preloaded, if any. Possible values are: none
, metadata
, auto
.
HTMLMediaElement.preservesPitch
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.remote
Read only
Return a RemotePlayback
object instance associated with the media element.
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 Secure context
Returns a string that is the unique ID of the audio device delivering output, or an empty string if the user agent default audio device is being used.
HTMLMediaElement.src
A string that reflects the src
HTML attribute, which contains the URL of a media resource to use.
HTMLMediaElement.srcObject
An object which serves as the source of the media associated with the HTMLMediaElement
, or null
if not assigned.
HTMLMediaElement.textTracks
Read only
Returns a TextTrackList
object containing the list of TextTrack
objects contained in the element.
HTMLMediaElement.videoTracks
Read only
Returns a VideoTrackList
object containing the list of VideoTrack
objects contained in the element.
HTMLMediaElement.volume
A double
indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).
These properties are obsolete and should not be used, even if a browser still supports them.
HTMLMediaElement.controller
Deprecated Non-standard
A MediaController
object that represents the media controller assigned to the element, or null
if none is assigned.
HTMLMediaElement.mediaGroup
Deprecated Non-standard
A string 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.mozAudioCaptured
Read only Non-standard Deprecated
Returns a boolean. Related to audio stream capture.
HTMLMediaElement.mozFragmentEnd
Non-standard Deprecated
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.
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 string probably
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()
Deprecated Non-standard
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()
Secure context
Returns Promise
. Sets the MediaKeys
keys to use when decrypting media during playback.
HTMLMediaElement.setSinkId()
Secure context
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.
These methods are obsolete and should not be used, even if a browser still supports them.
HTMLMediaElement.mozCaptureStream()
Non-standard
The Firefox-prefixed equivalent of HTMLMediaElement.captureStream()
. See its browser compatibility for details.
HTMLMediaElement.mozCaptureStreamUntilEnded()
Non-standard Deprecated
[enter description]
HTMLMediaElement.mozGetMetadata()
Non-standard Deprecated
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.
Inherits events from its parent, HTMLElement
.
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.
encrypted
Fired when initialization data is found in the media that indicates the media is encrypted.
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 from true
to false
, as a result of the HTMLMediaElement.play()
method, or the autoplay
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.
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.
waitingforkey
Fired when playback is first blocked while waiting for a key.
<video>
and <audio>
HTML elementsHTMLVideoElement
and HTMLAudioElement
interfaces, derived from HTMLMediaElement
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4