haXe API Documentation
Back | Index
extern class js.html.MediaElement
extends Element
Available in js
HTML media elements (such as <audio> and <video> ) expose the HTMLMediaElement interface which provides special properties and methods (beyond the regular element object interface they also have available to them by inheritance) for manipulating the layout and presentation of media elements.

Documentation for this class was provided by MDN.
var audioDecodedByteCount(default,null) : Int
var autoplay : Bool

Reflects the

autoplay HTML attribute, indicating whether to begin playing as soon as enough media is available.

var buffered(default,null) : TimeRanges
The ranges of the media source that the browser has buffered, if any.
var closedCaptionsVisible : Bool
var controller : MediaController
var controls : Bool

Reflects the

controls HTML attribute, indicating whether user interface items for controlling the resource should be displayed.

var currentSrc(default,null) : String
The absolute URL of the chosen media resource (if, for example, the server selects a media file based on the resolution of the user's display), or an empty string if the networkState is EMPTY.
var currentTime : Float
The current playback time, in seconds.  Setting this value seeks the media to the new time. Setter throws DOMException.
var defaultMuted : Bool

Reflects the

muted HTML attribute, indicating whether the media element's audio output should be muted by default. Changing the value dynamically will not unmute the audio (it only controls the default state).

var defaultPlaybackRate : Float
The default playback rate for the media.  The Ogg backend does not support this.  1.0 is "normal speed," values lower than 1.0 make the media play slower than normal, higher values make it play faster.  The value 0.0 is invalid and throws a NOT_SUPPORTED_ERR exception.
var duration(default,null) : Float
The length of the media in seconds, or zero if no media data is available.  If the media data is available but the length is unknown, this value is NaN.  If the media is streamed and has no predefined length, the value is Inf.
var ended(default,null) : Bool
Indicates whether the media element has ended playback.
var error(default,null) : MediaError
The media error object for the most recent error, or null if there has not been an error.
var hasClosedCaptions(default,null) : Bool
var initialTime(default,null) : Float
var loop : Bool

Reflects the

loop HTML attribute, indicating whether the media element should start over when it reaches the end.

var mediaGroup : String
var muted : Bool
true if the audio is muted, and false otherwise.
var networkState(default,null) : Int

The current state of fetching the media over the network.

Constant Value Description
EMPTY 0 There is no data yet.  The readyState is also HAVE_NOTHING.
LOADING 1 The media is loading.
LOADED_METADATA 2 The media's metadata has been loaded.
LOADED_FIRST_FRAME 3 The media's first frame has been loaded.
LOADED 4 The media has been fully loaded.
var onkeyadded : EventListener
var onkeyerror : EventListener
var onkeymessage : EventListener
var onneedkey : EventListener
var paused(default,null) : Bool
Indicates whether the media element is paused.
var playbackRate : Float
The current rate at which the media is being played back. This is used to implement user controls for fast forward, slow motion, and so forth. The normal playback rate is multiplied by this value to obtain the current rate, so a value of 1.0 indicates normal speed.  Not supported by the Ogg backend.
var played(default,null) : TimeRanges
The ranges of the media source that the browser has played, if any.
var preload : String

Reflects the

preload HTML attribute, indicating what data should be preloaded at page-load time, if any.

var preservesPitch : Bool
var readyState(default,null) : Int

The readiness state of the media:

Constant Value Description
HAVE_NOTHING 0 No information is available about the media resource.
HAVE_METADATA 1 Enough of the media resource has been retrieved that the metadata attributes are initialized.  Seeking will no longer raise an exception.
HAVE_CURRENT_DATA 2 Data is available for the current playback position, but not enough to actually play more than one frame.
HAVE_FUTURE_DATA 3 Data for the current playback position as well as for at least a little bit of time into the future is available (in other words, at least two frames of video, for example).
HAVE_ENOUGH_DATA 4 Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.
var seekable(default,null) : TimeRanges
The time ranges that the user is able to seek to, if any.
var seeking(default,null) : Bool
Indicates whether the media is in the process of seeking to a new position.
var src : String

Reflects the

src HTML attribute, containing the URL of a media resource to use.

var startTime(default,null) : Float
The earliest possible position in the media, in seconds.
var textTracks(default,null) : TextTrackList
var videoDecodedByteCount(default,null) : Int
var volume : Float
The audio volume, from 0.0 (silent) to 1.0 (loudest). Setter throws DOMException.
function addKey(keySystem : String, key : Uint8Array, ?initData : Uint8Array, sessionId : String) : Void
function addTextTrack(kind : String, ?label : String, ?language : String) : TextTrack
function canPlayType(type : String, keySystem : String) : String
function cancelKeyRequest(keySystem : String, sessionId : String) : Void
function generateKeyRequest(keySystem : String, ?initData : Uint8Array) : Void
function load() : Void
function pause() : Void
function play() : Void
static inline var HAVE_CURRENT_DATA : Int
Data is available for the current playback position, but not enough to actually play more than one frame.
static inline var HAVE_ENOUGH_DATA : Int
Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.
static inline var HAVE_FUTURE_DATA : Int
Data for the current playback position as well as for at least a little bit of time into the future is available (in other words, at least two frames of video, for example).
static inline var HAVE_METADATA : Int
Enough of the media resource has been retrieved that the metadata attributes are initialized.  Seeking will no longer raise an exception.
static inline var HAVE_NOTHING : Int
No information is available about the media resource.
static inline var NETWORK_EMPTY : Int
static inline var NETWORK_IDLE : Int
static inline var NETWORK_LOADING : Int
static inline var NETWORK_NO_SOURCE : Int
Back | Index