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 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.currentSrcRead 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.durationRead only

Returns a double indicating the length of the media in seconds, or 0 if no media data is available.

HTMLMediaElement.endedRead only

Returns a Boolean that indicates whether the media element has finished playing.

HTMLMediaElement.errorRead only

Returns a MediaError object for the most recent error, or null if there has not been an error.

HTMLMediaElement.initialTimeRead only

Returns a double that indicates the initial playback position in seconds.

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.mediaKeysRead 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.mozAudioCapturedRead only

Returns a Boolean. Related to audio stream capture.

HTMLMediaElement.mozChannelsRead only

Returns a double representing the number of channels in the audio resource (e.g., 2 for stereo).

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.mozSampleRateRead 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.networkStateRead only

Returns a unsigned short (enumeration) indicating the current state of fetching the media over the network.

HTMLMediaElement.pausedRead 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.playedRead 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.readyStateRead only

Returns a unsigned short (enumeration) indicating the readiness state of the media.

HTMLMediaElement.seekableRead only

Returns a TimeRanges object that contains the time ranges that the user is able to seek to, if any.

HTMLMediaElement.seekingRead only

Returns a Boolean that indicates whether the media is in the process of seeking to a new position.

HTMLMediaElement.sinkIdRead 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.textTracksRead only

Returns the list of TextTrack objects contained in the element.

HTMLMediaElement.videoTracksRead 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.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.

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.

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.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.

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.

Specifications

Browser compatibility

[1] The NETWORK_LOADED state was removed to align with the HTML spec in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1).

[2] Previously Gecko implemented this as autobuffer.

[3] Gecko implements this in lowercase, i.e. crossorigin.

[4] The feature was removed in Gecko 23.0 (Firefox 23 / Thunderbird 23 / SeaMonkey 2.20).

[5] The implementation is hidden behind the media.track.enabled preference.

[6] The implementation is hidden behind the media.webvtt.enabled preference, defaulting there to true.

[7] This feature was removed in 24.0 (24).

[8] Gecko doesn't implement this yet. See bug 847376.

[9] Gecko doesn't implement this yet. See bug 847377.

[10] The preference media.seekToNextFrame must be enabled to use the seekToNextFrame() method.

[11] The proprietary mozSrcObject property was removed in Firefox 58 (bug 1183495). Use the standard HTMLMediaElement.srcObject property instead.

See also

• References
  • <video> and <audio> HTML elements.
  • HTMLVideoElement and HTMLAudioElement interfaces, derived from HTMLMediaElement.
• Articles
  • Using HTML5 audio and video
  • Media formats supported by the audio and video elements
  • Web Audio API