HaxeFoundation.haxe/std/js/html/MediaElement.hx

/*
 * Copyright (C)2005-2013 Haxe Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

// This file is generated, do not edit!
package js.html;

/** HTML media elements (such as <code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/audio">&lt;audio&gt;</a></code>
 and <code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video">&lt;video&gt;</a></code>
) expose the <code>HTMLMediaElement</code> interface which provides special properties and methods (beyond the regular <a href="/api/js/html/Element" rel="internal">element</a> object interface they also have available to them by inheritance) for manipulating the layout and presentation of media elements.<br><br>
Documentation for this class was provided by <a href="https://developer.mozilla.org/en/DOM/HTMLMediaElement">MDN</a>. */
@:native("HTMLMediaElement")
extern class MediaElement extends Element
{
	/** Data is available for the current playback position, but not enough to actually play more than one frame. */
	static inline var HAVE_CURRENT_DATA : Int = 2;

	/** 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_ENOUGH_DATA : Int = 4;

	/** 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_FUTURE_DATA : Int = 3;

	/** Enough of the media resource has been retrieved that the metadata attributes are initialized.&nbsp; Seeking will no longer raise an exception. */
	static inline var HAVE_METADATA : Int = 1;

	/** No information is available about the media resource. */
	static inline var HAVE_NOTHING : Int = 0;

	static inline var NETWORK_EMPTY : Int = 0;

	static inline var NETWORK_IDLE : Int = 1;

	static inline var NETWORK_LOADING : Int = 2;

	static inline var NETWORK_NO_SOURCE : Int = 3;

	var audioDecodedByteCount(default,null) : Int;

	/** Reflects the 

<code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video#attr-autoplay">autoplay</a></code>
 HTML&nbsp;attribute, indicating whether to begin playing as soon as enough media is available. */
	var autoplay : Bool;

	/** The ranges of the media source that the browser has buffered, if any. */
	var buffered(default,null) : TimeRanges;

	var closedCaptionsVisible : Bool;

	var controller : MediaController;

	/** Reflects the 

<code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video#attr-controls">controls</a></code>
 HTML attribute, indicating whether user interface items for controlling the resource should be displayed. */
	var controls : Bool;

	/** 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 <code>networkState</code> is <code>EMPTY</code>. */
	var currentSrc(default,null) : String;

	/** The current playback time, in seconds.&nbsp; Setting this value seeks the media to the new time. Setter throws DOMException. */
	var currentTime : Float;

	/** Reflects the 

<code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video#attr-muted">muted</a></code>
 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 defaultMuted : Bool;

	/** The default playback rate for the media.&nbsp; The Ogg backend does not support this.&nbsp; 1.0 is "normal speed," values lower than 1.0 make the media play slower than normal, higher values make it play faster.&nbsp; The value 0.0 is invalid and throws a <code>NOT_SUPPORTED_ERR</code>&nbsp;exception. */
	var defaultPlaybackRate : Float;

	/** The length of the media in seconds, or zero if no media data is available.&nbsp; If the media data is available but the length is unknown, this value is <code>NaN</code>.&nbsp; If the media is streamed and has no predefined length, the value is <code>Inf</code>. */
	var duration(default,null) : Float;

	/** Indicates whether the media element has ended playback. */
	var ended(default,null) : Bool;

	/** The media error object for the most recent error, or null if there has not been an error. */
	var error(default,null) : MediaError;

	var hasClosedCaptions(default,null) : Bool;

	var initialTime(default,null) : Float;

	/** Reflects the 

<code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video#attr-loop">loop</a></code>
 HTML&nbsp;attribute, indicating whether the media element should start over when it reaches the end. */
	var loop : Bool;

	var mediaGroup : String;

	/** <code>true</code> if the audio is muted, and <code>false</code> otherwise. */
	var muted : Bool;

	/** <p>The current state of fetching the media over the network.</p> <table class="standard-table"> <tbody> <tr> <td class="header">Constant</td> <td class="header">Value</td> <td class="header">Description</td> </tr> <tr> <td><code>EMPTY</code></td> <td>0</td> <td>There is no data yet.&nbsp; The <code>readyState</code> is also <code>HAVE_NOTHING</code>.</td> </tr> <tr> <td><code>LOADING</code></td> <td>1</td> <td>The media is loading.</td> </tr> <tr> <td><code>LOADED_METADATA</code></td> <td>2</td> <td>The media's metadata has been loaded.</td> </tr> <tr> <td><code>LOADED_FIRST_FRAME</code></td> <td>3</td> <td>The media's first frame has been loaded.</td> </tr> <tr> <td><code>LOADED</code></td> <td>4</td> <td>The media has been fully loaded.</td> </tr> </tbody> </table> */
	var networkState(default,null) : Int;

	var onkeyadded : EventListener;

	var onkeyerror : EventListener;

	var onkeymessage : EventListener;

	var onneedkey : EventListener;

	/** Indicates whether the media element is paused. */
	var paused(default,null) : Bool;

	/** 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.&nbsp; Not supported by the Ogg backend. */
	var playbackRate : Float;

	/** The ranges of the media source that the browser has played, if any. */
	var played(default,null) : TimeRanges;

	/** Reflects the 

<code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video#attr-preload">preload</a></code>
 HTML attribute, indicating what data should be preloaded at page-load time, if any. */
	var preload : String;

	var preservesPitch : Bool;

	/** <p>The readiness state of the media:</p> <table class="standard-table"> <tbody> <tr> <td class="header">Constant</td> <td class="header">Value</td> <td class="header">Description</td> </tr> <tr> <td><code>HAVE_NOTHING</code></td> <td>0</td> <td>No information is available about the media resource.</td> </tr> <tr> <td><code>HAVE_METADATA</code></td> <td>1</td> <td>Enough of the media resource has been retrieved that the metadata attributes are initialized.&nbsp; Seeking will no longer raise an exception.</td> </tr> <tr> <td><code>HAVE_CURRENT_DATA</code></td> <td>2</td> <td>Data is available for the current playback position, but not enough to actually play more than one frame.</td> </tr> <tr> <td><code>HAVE_FUTURE_DATA</code></td> <td>3</td> <td>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).</td> </tr> <tr> <td><code>HAVE_ENOUGH_DATA</code></td> <td>4</td> <td>Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.</td> </tr> </tbody> </table> */
	var readyState(default,null) : Int;

	/** The time ranges that the user is able to seek to, if any. */
	var seekable(default,null) : TimeRanges;

	/** Indicates whether the media is in the process of seeking to a new position. */
	var seeking(default,null) : Bool;

	/** Reflects the 

<code><a rel="custom" href="https://developer.mozilla.org/en/HTML/Element/video#attr-src">src</a></code>
 HTML attribute, containing the URL of a media resource to use. */
	var src : String;

	/** The earliest possible position in the media, in seconds. */
	var startTime(default,null) : Float;

	var textTracks(default,null) : TextTrackList;

	var videoDecodedByteCount(default,null) : Int;

	/** The audio volume, from 0.0 (silent) to 1.0 (loudest). Setter throws DOMException. */
	var volume : Float;

	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;

}