MediaElement (GWT 2.7.0)

All Superinterfaces:

Element, ElementTraversal, EventTarget, Node, NodeSelector

All Known Subinterfaces:

AudioElement, VideoElement

All Known Implementing Classes:

JsAudioElement, JsMediaElement, JsVideoElement
```
public interface MediaElement
extends Element
```
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.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EOS_DECODE_ERR`
`static int`	`EOS_NETWORK_ERR`
`static int`	`EOS_NO_ERROR`
`static int`	`HAVE_CURRENT_DATA` Data is available for the current playback position, but not enough to actually play more than one frame.
`static int`	`HAVE_ENOUGH_DATA` Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.
`static int`	`HAVE_FUTURE_DATA` 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 int`	`HAVE_METADATA` Enough of the media resource has been retrieved that the metadata attributes are initialized. Seeking will no longer raise an exception.
`static int`	`HAVE_NOTHING` No information is available about the media resource.
`static int`	`NETWORK_EMPTY`
`static int`	`NETWORK_IDLE`
`static int`	`NETWORK_LOADING`
`static int`	`NETWORK_NO_SOURCE`
`static int`	`SOURCE_CLOSED`
`static int`	`SOURCE_ENDED`
`static int`	`SOURCE_OPEN`

Fields inherited from interface elemental.dom.Element
ALLOW_KEYBOARD_INPUT

Method Summary

Methods
Modifier and Type	Method and Description
`TextTrack`	`addTextTrack(String kind)`
`TextTrack`	`addTextTrack(String kind, String label)`
`TextTrack`	`addTextTrack(String kind, String label, String language)`
`String`	`canPlayType(String type, String keySystem)` Determines whether the specified media type can be played back.
`TimeRanges`	`getBuffered()` The ranges of the media source that the browser has buffered, if any.
`MediaController`	`getController()`
`String`	`getCurrentSrc()` 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`.
`float`	`getCurrentTime()` The current playback time, in seconds. Setting this value seeks the media to the new time.
`float`	`getDefaultPlaybackRate()` 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.
`float`	`getDuration()` 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`.
`MediaError`	`getError()` The media error object for the most recent error, or null if there has not been an error.
`double`	`getInitialTime()`
`String`	`getMediaGroup()`
`int`	`getNetworkState()` The current state of fetching the media over the network.
`EventListener`	`getOnwebkitkeyadded()`
`EventListener`	`getOnwebkitkeyerror()`
`EventListener`	`getOnwebkitkeymessage()`
`EventListener`	`getOnwebkitneedkey()`
`EventListener`	`getOnwebkitsourceclose()`
`EventListener`	`getOnwebkitsourceended()`
`EventListener`	`getOnwebkitsourceopen()`
`float`	`getPlaybackRate()` The current rate at which the media is being played back.
`TimeRanges`	`getPlayed()` The ranges of the media source that the browser has played, if any.
`String`	`getPreload()` Reflects the `preload` HTML attribute, indicating what data should be preloaded at page-load time, if any.
`int`	`getReadyState()` The readiness state of the media:
`TimeRanges`	`getSeekable()` The time ranges that the user is able to seek to, if any.
`String`	`getSrc()` Reflects the `src` HTML attribute, containing the URL of a media resource to use.
`float`	`getStartTime()` The earliest possible position in the media, in seconds.
`TextTrackList`	`getTextTracks()`
`float`	`getVolume()` The audio volume, from 0.0 (silent) to 1.0 (loudest).
`int`	`getWebkitAudioDecodedByteCount()`
`String`	`getWebkitMediaSourceURL()`
`int`	`getWebkitSourceState()`
`int`	`getWebkitVideoDecodedByteCount()`
`boolean`	`isAutoplay()` Reflects the `autoplay` HTML attribute, indicating whether to begin playing as soon as enough media is available.
`boolean`	`isControls()` Reflects the `controls` HTML attribute, indicating whether user interface items for controlling the resource should be displayed.
`boolean`	`isDefaultMuted()` Reflects the `muted` HTML attribute, indicating whether the media element's audio output should be muted by default.
`boolean`	`isEnded()` Indicates whether the media element has ended playback.
`boolean`	`isLoop()` Reflects the `loop` HTML attribute, indicating whether the media element should start over when it reaches the end.
`boolean`	`isMuted()` `true` if the audio is muted, and `false` otherwise.
`boolean`	`isPaused()` Indicates whether the media element is paused.
`boolean`	`isSeeking()` Indicates whether the media is in the process of seeking to a new position.
`boolean`	`isWebkitClosedCaptionsVisible()`
`boolean`	`isWebkitHasClosedCaptions()`
`boolean`	`isWebkitPreservesPitch()`
`void`	`load()` Begins loading the media content from the server.
`void`	`pause()` Pauses the media playback.
`void`	`play()` Begins playback of the media.
`void`	`setAutoplay(boolean arg)`
`void`	`setController(MediaController arg)`
`void`	`setControls(boolean arg)`
`void`	`setCurrentTime(float arg)`
`void`	`setDefaultMuted(boolean arg)`
`void`	`setDefaultPlaybackRate(float arg)`
`void`	`setLoop(boolean arg)`
`void`	`setMediaGroup(String arg)`
`void`	`setMuted(boolean arg)`
`void`	`setOnwebkitkeyadded(EventListener arg)`
`void`	`setOnwebkitkeyerror(EventListener arg)`
`void`	`setOnwebkitkeymessage(EventListener arg)`
`void`	`setOnwebkitneedkey(EventListener arg)`
`void`	`setOnwebkitsourceclose(EventListener arg)`
`void`	`setOnwebkitsourceended(EventListener arg)`
`void`	`setOnwebkitsourceopen(EventListener arg)`
`void`	`setPlaybackRate(float arg)`
`void`	`setPreload(String arg)`
`void`	`setSrc(String arg)`
`void`	`setVolume(float arg)`
`void`	`setWebkitClosedCaptionsVisible(boolean arg)`
`void`	`setWebkitPreservesPitch(boolean arg)`
`void`	`webkitAddKey(String keySystem, Uint8Array key)`
`void`	`webkitAddKey(String keySystem, Uint8Array key, Uint8Array initData, String sessionId)`
`void`	`webkitCancelKeyRequest(String keySystem, String sessionId)`
`void`	`webkitGenerateKeyRequest(String keySystem)`
`void`	`webkitGenerateKeyRequest(String keySystem, Uint8Array initData)`
`void`	`webkitSourceAbort(String id)`
`void`	`webkitSourceAddId(String id, String type)`
`void`	`webkitSourceAppend(String id, Uint8Array data)`
`TimeRanges`	`webkitSourceBuffered(String id)`
`void`	`webkitSourceEndOfStream(int status)`
`void`	`webkitSourceRemoveId(String id)`

Methods inherited from interface elemental.dom.Element
blur, click, focus, getAccessKey, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getBoundingClientRect, getChildElementCount, getChildren, getClassList, getClassName, getClientHeight, getClientLeft, getClientRects, getClientTop, getClientWidth, getContentEditable, getDataset, getDir, getElementsByClassName, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getId, getInnerHTML, getInnerText, getLang, getLastElementChild, getNextElementSibling, getOffsetHeight, getOffsetLeft, getOffsetParent, getOffsetTop, getOffsetWidth, getOnabort, getOnbeforecopy, getOnbeforecut, getOnbeforepaste, getOnblur, getOnchange, getOnclick, getOncontextmenu, getOncopy, getOncut, getOndblclick, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOnerror, getOnfocus, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnselect, getOnselectstart, getOnsubmit, getOntouchcancel, getOntouchend, getOntouchmove, getOntouchstart, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getOuterHTML, getOuterText, getPreviousElementSibling, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getStyle, getTabIndex, getTagName, getTitle, getWebkitdropzone, getWebkitRegionOverflow, hasAttribute, hasAttributeNS, insertAdjacentElement, insertAdjacentHTML, insertAdjacentText, isContentEditable, isDraggable, isHidden, isSpellcheck, isTranslate, querySelector, querySelectorAll, removeAttribute, removeAttributeNode, removeAttributeNS, scrollByLines, scrollByPages, scrollIntoView, scrollIntoView, scrollIntoViewIfNeeded, scrollIntoViewIfNeeded, setAccessKey, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setClassName, setContentEditable, setDir, setDraggable, setHidden, setId, setInnerHTML, setInnerText, setLang, setOnabort, setOnbeforecopy, setOnbeforecut, setOnbeforepaste, setOnblur, setOnchange, setOnclick, setOncontextmenu, setOncopy, setOncut, setOndblclick, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOnerror, setOnfocus, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnselect, setOnselectstart, setOnsubmit, setOntouchcancel, setOntouchend, setOntouchmove, setOntouchstart, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setOuterHTML, setOuterText, setScrollLeft, setScrollTop, setSpellcheck, setTabIndex, setTitle, setTranslate, setWebkitdropzone, webkitMatchesSelector, webkitRequestFullscreen, webkitRequestFullScreen

Field Detail
- EOS_DECODE_ERR
```
static final int EOS_DECODE_ERR
```
  See Also:
  Constant Field Values
- EOS_NETWORK_ERR
```
static final int EOS_NETWORK_ERR
```
  See Also:
  Constant Field Values
- EOS_NO_ERROR
```
static final int EOS_NO_ERROR
```
  See Also:
  Constant Field Values
- HAVE_CURRENT_DATA
```
static final int HAVE_CURRENT_DATA
```
  Data is available for the current playback position, but not enough to actually play more than one frame.
  
  See Also:
  Constant Field Values
- HAVE_ENOUGH_DATA
```
static final int HAVE_ENOUGH_DATA
```
  Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.
  
  See Also:
  Constant Field Values
- HAVE_FUTURE_DATA
```
static final int HAVE_FUTURE_DATA
```
  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).
  
  See Also:
  Constant Field Values
- HAVE_METADATA
```
static final int HAVE_METADATA
```
  Enough of the media resource has been retrieved that the metadata attributes are initialized. Seeking will no longer raise an exception.
  
  See Also:
  Constant Field Values
- HAVE_NOTHING
```
static final int HAVE_NOTHING
```
  No information is available about the media resource.
  
  See Also:
  Constant Field Values
- NETWORK_EMPTY
```
static final int NETWORK_EMPTY
```
  See Also:
  Constant Field Values
- NETWORK_IDLE
```
static final int NETWORK_IDLE
```
  See Also:
  Constant Field Values
- NETWORK_LOADING
```
static final int NETWORK_LOADING
```
  See Also:
  Constant Field Values
- NETWORK_NO_SOURCE
```
static final int NETWORK_NO_SOURCE
```
  See Also:
  Constant Field Values
- SOURCE_CLOSED
```
static final int SOURCE_CLOSED
```
  See Also:
  Constant Field Values
- SOURCE_ENDED
```
static final int SOURCE_ENDED
```
  See Also:
  Constant Field Values
- SOURCE_OPEN
```
static final int SOURCE_OPEN
```
  See Also:
  Constant Field Values

Method Detail

isAutoplay
```
boolean isAutoplay()
```
Reflects the autoplay HTML attribute, indicating whether to begin playing as soon as enough media is available.

setAutoplay
```
void setAutoplay(boolean arg)
```

getBuffered
```
TimeRanges getBuffered()
```
The ranges of the media source that the browser has buffered, if any.

getController
```
MediaController getController()
```

setController

void setController(MediaController arg)

isControls
```
boolean isControls()
```
Reflects the controls HTML attribute, indicating whether user interface items for controlling the resource should be displayed.

setControls
```
void setControls(boolean arg)
```

getCurrentSrc
```
String getCurrentSrc()
```
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.

getCurrentTime
```
float getCurrentTime()
```
The current playback time, in seconds. Setting this value seeks the media to the new time.

setCurrentTime
```
void setCurrentTime(float arg)
```

isDefaultMuted
```
boolean isDefaultMuted()
```
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).

setDefaultMuted
```
void setDefaultMuted(boolean arg)
```

getDefaultPlaybackRate
```
float getDefaultPlaybackRate()
```
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.

setDefaultPlaybackRate

void setDefaultPlaybackRate(float arg)

getDuration
```
float getDuration()
```
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.

isEnded
```
boolean isEnded()
```
Indicates whether the media element has ended playback.

getError
```
MediaError getError()
```
The media error object for the most recent error, or null if there has not been an error.

getInitialTime
```
double getInitialTime()
```

isLoop
```
boolean isLoop()
```
Reflects the loop HTML attribute, indicating whether the media element should start over when it reaches the end.

setLoop
```
void setLoop(boolean arg)
```

getMediaGroup
```
String getMediaGroup()
```

setMediaGroup
```
void setMediaGroup(String arg)
```

isMuted
```
boolean isMuted()
```
true if the audio is muted, and false otherwise.

setMuted
```
void setMuted(boolean arg)
```

getNetworkState

int getNetworkState()

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.

getOnwebkitkeyadded
```
EventListener getOnwebkitkeyadded()
```

setOnwebkitkeyadded

void setOnwebkitkeyadded(EventListener arg)

getOnwebkitkeyerror
```
EventListener getOnwebkitkeyerror()
```

setOnwebkitkeyerror

void setOnwebkitkeyerror(EventListener arg)

getOnwebkitkeymessage
```
EventListener getOnwebkitkeymessage()
```

setOnwebkitkeymessage

void setOnwebkitkeymessage(EventListener arg)

getOnwebkitneedkey
```
EventListener getOnwebkitneedkey()
```

setOnwebkitneedkey

void setOnwebkitneedkey(EventListener arg)

getOnwebkitsourceclose
```
EventListener getOnwebkitsourceclose()
```

setOnwebkitsourceclose

void setOnwebkitsourceclose(EventListener arg)

getOnwebkitsourceended
```
EventListener getOnwebkitsourceended()
```

setOnwebkitsourceended

void setOnwebkitsourceended(EventListener arg)

getOnwebkitsourceopen
```
EventListener getOnwebkitsourceopen()
```

setOnwebkitsourceopen

void setOnwebkitsourceopen(EventListener arg)

isPaused
```
boolean isPaused()
```
Indicates whether the media element is paused.

getPlaybackRate
```
float getPlaybackRate()
```
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.

setPlaybackRate
```
void setPlaybackRate(float arg)
```

getPlayed
```
TimeRanges getPlayed()
```
The ranges of the media source that the browser has played, if any.

getPreload
```
String getPreload()
```
Reflects the preload HTML attribute, indicating what data should be preloaded at page-load time, if any.

setPreload
```
void setPreload(String arg)
```

getReadyState

int getReadyState()

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.

getSeekable
```
TimeRanges getSeekable()
```
The time ranges that the user is able to seek to, if any.

isSeeking
```
boolean isSeeking()
```
Indicates whether the media is in the process of seeking to a new position.

getSrc
```
String getSrc()
```
Reflects the src HTML attribute, containing the URL of a media resource to use.

setSrc
```
void setSrc(String arg)
```

getStartTime
```
float getStartTime()
```
The earliest possible position in the media, in seconds.

getTextTracks
```
TextTrackList getTextTracks()
```

getVolume
```
float getVolume()
```
The audio volume, from 0.0 (silent) to 1.0 (loudest).

setVolume
```
void setVolume(float arg)
```

getWebkitAudioDecodedByteCount
```
int getWebkitAudioDecodedByteCount()
```

isWebkitClosedCaptionsVisible

boolean isWebkitClosedCaptionsVisible()

setWebkitClosedCaptionsVisible

void setWebkitClosedCaptionsVisible(boolean arg)

isWebkitHasClosedCaptions
```
boolean isWebkitHasClosedCaptions()
```

getWebkitMediaSourceURL
```
String getWebkitMediaSourceURL()
```

isWebkitPreservesPitch
```
boolean isWebkitPreservesPitch()
```

setWebkitPreservesPitch

void setWebkitPreservesPitch(boolean arg)

getWebkitSourceState
```
int getWebkitSourceState()
```

getWebkitVideoDecodedByteCount
```
int getWebkitVideoDecodedByteCount()
```

addTextTrack
```
TextTrack addTextTrack(String kind)
```

addTextTrack

TextTrack addTextTrack(String kind,
                     String label)

addTextTrack

TextTrack addTextTrack(String kind,
                     String label,
                     String language)

canPlayType

String canPlayType(String type,
                 String keySystem)

Determines whether the specified media type can be played back.

load
```
void load()
```
Begins loading the media content from the server.

pause
```
void pause()
```
Pauses the media playback.

play
```
void play()
```
Begins playback of the media. If you have changed the src attribute of the media element since the page was loaded, you must call load() before play(), otherwise the original media plays again.

webkitAddKey

void webkitAddKey(String keySystem,
                Uint8Array key)

webkitAddKey

void webkitAddKey(String keySystem,
                Uint8Array key,
                Uint8Array initData,
                String sessionId)

webkitCancelKeyRequest

void webkitCancelKeyRequest(String keySystem,
                          String sessionId)

webkitGenerateKeyRequest

void webkitGenerateKeyRequest(String keySystem)

webkitGenerateKeyRequest

void webkitGenerateKeyRequest(String keySystem,
                            Uint8Array initData)

webkitSourceAbort
```
void webkitSourceAbort(String id)
```

webkitSourceAddId

void webkitSourceAddId(String id,
                     String type)

webkitSourceAppend

void webkitSourceAppend(String id,
                      Uint8Array data)

webkitSourceBuffered

TimeRanges webkitSourceBuffered(String id)

webkitSourceEndOfStream

void webkitSourceEndOfStream(int status)

webkitSourceRemoveId
```
void webkitSourceRemoveId(String id)
```

Interface MediaElement

Field Summary

Fields inherited from interface elemental.dom.Element

Fields inherited from interface elemental.dom.Node

Method Summary

Methods inherited from interface elemental.dom.Element

Methods inherited from interface elemental.dom.Node

Field Detail

EOS_DECODE_ERR

EOS_NETWORK_ERR

EOS_NO_ERROR

HAVE_CURRENT_DATA

HAVE_ENOUGH_DATA

HAVE_FUTURE_DATA

HAVE_METADATA

HAVE_NOTHING

NETWORK_EMPTY

NETWORK_IDLE

NETWORK_LOADING

NETWORK_NO_SOURCE

SOURCE_CLOSED

SOURCE_ENDED

SOURCE_OPEN

Method Detail

isAutoplay

setAutoplay

getBuffered

getController

setController

isControls

setControls

getCurrentSrc

getCurrentTime

setCurrentTime

isDefaultMuted

setDefaultMuted

getDefaultPlaybackRate

setDefaultPlaybackRate

getDuration

isEnded

getError

getInitialTime

isLoop

setLoop

getMediaGroup

setMediaGroup

isMuted

setMuted

getNetworkState

getOnwebkitkeyadded

setOnwebkitkeyadded

getOnwebkitkeyerror

setOnwebkitkeyerror

getOnwebkitkeymessage

setOnwebkitkeymessage

getOnwebkitneedkey

setOnwebkitneedkey

getOnwebkitsourceclose

setOnwebkitsourceclose

getOnwebkitsourceended

setOnwebkitsourceended

getOnwebkitsourceopen

setOnwebkitsourceopen

isPaused

getPlaybackRate

setPlaybackRate

getPlayed

getPreload

setPreload

getReadyState

getSeekable

isSeeking

getSrc

setSrc

getStartTime

getTextTracks

getVolume

setVolume

getWebkitAudioDecodedByteCount

isWebkitClosedCaptionsVisible