HTMLMediaElement

#include <HTMLMediaElement.idl>

Inherits from HTMLElement, Element, Node, EventTarget

Public Functions

	Name
int	cohPrebufferKeyframe(double timestamp) Prebuffers a keyframe for faster seek. Requires exact timestamp of the keyframe. Throws an error on failure.
sequence< double >	cohGetKeyframeTimestamps() Obtains the information for keyframe timestamps from video metadata.
void	load()
CanPlayTypeEnum	canPlayType(DOMString type)
void	play()
void	pause()

Public Attributes

	Name
attribute boolean	cohFastSeek A boolean that controls the seek behavior When true the seek requests will seek to the nearest keyframe instead to a specific timepoint, which improves seek performance.
readonly attribute MediaError	error
attribute DOMString	src
attribute MediaSource	srcObject
readonly attribute DOMString	currentSrc
attribute DOMString	crossOrigin
const unsigned short	NETWORK_EMPTY
const unsigned short	NETWORK_IDLE
const unsigned short	NETWORK_LOADING
const unsigned short	NETWORK_NO_SOURCE
readonly attribute unsigned short	networkState
attribute DOMString	preload “none” or “auto” to preload keyframes for better seek performance
readonly attribute TimeRanges	buffered
const unsigned short	HAVE_NOTHING
const unsigned short	HAVE_METADATA
const unsigned short	HAVE_CURRENT_DATA
const unsigned short	HAVE_FUTURE_DATA
const unsigned short	HAVE_ENOUGH_DATA
readonly attribute unsigned short	readyState
readonly attribute boolean	seeking
attribute double	currentTime
readonly attribute unrestricted double	duration
readonly attribute boolean	paused
attribute double	defaultPlaybackRate
attribute double	playbackRate
readonly attribute TimeRanges	played
readonly attribute TimeRanges	seekable
readonly attribute boolean	ended
attribute boolean	autoplay
attribute boolean	loop
attribute double	volume
attribute boolean	muted
attribute EventSetter	durationchange
attribute EventSetter	emptied
attribute EventSetter	ended
attribute EventSetter	error
attribute EventSetter	loadstart
attribute EventSetter	seeked
attribute EventSetter	seeking
attribute EventSetter	timeupdate
attribute EventSetter	volumechange
attribute EventSetter	resize

Additional inherited members

Public Functions inherited from HTMLElement

	Name
HTMLElement	HTMLElement()

Public Attributes inherited from HTMLElement

	Name
readonly attribute DOMStringMap	dataset
readonly attribute CSSStyleDeclaration	style
readonly attribute StylePropertyMap	attributeStyleMap
readonly attribute Element	offsetParent
readonly attribute long	offsetTop
readonly attribute long	offsetLeft
readonly attribute long	offsetWidth
readonly attribute long	offsetHeight

Public Functions inherited from Element

	Name
void	setAttribute(DOMString qualifiedName, DOMString value) sets the given attribute name to the specified value
void	setAttributeNS(DOMString ns, DOMString qualifiedName, DOMString value) sets the given attribute name to the specified value
void	removeAttribute(DOMString qualifiedName) removes the specified attribute
void	removeAttributeNS(DOMString ns, DOMString qualifiedName) removes the specified attribute
DOMString	getAttribute(DOMString qualifiedName) returns the attribute value for the given qualified name
DOMString	getAttributeNS(DOMString ns, DOMString qualifiedName) returns the attribute value for the given qualified name
boolean	hasAttribute(DOMString qualifiedName) returns whether the element has an attribute with the given qualified name
boolean	hasAttributeNS(DOMString ns, DOMString qualifiedName) returns whether the element has an attribute with the given qualified name
Attr	getAttributeNode(DOMString qualifiedName) Returns the specified attribute of the specified element, as an Attr node.
Attr	getAttributeNodeNS(DOMString? namespace, DOMString localName) Returns the Attr node for the attribute with the given namespace and name.
Attr	setAttributeNode(Attr attr) Adds a new Attr node to the specified element.
Attr	setAttributeNodeNS(Attr attr) Adds a new namespaced attribute node to an element.
Attr	removeAttributeNode(Attr attr) Removes the specified attribute from the current element.
boolean	hasAttributes() Returns Boolean value, indicating if the current element has any attributes or not.
sequenceDOMString	getAttributeNames() Must return the qualified names of the attributes in context objects attribute list, in order, and a new list otherwise.
HTMLCollection	getElementsByTagName(DOMString qualifiedName) Returns the list of elements with qualified name qualifiedName for context object.
HTMLCollection	getElementsByTagNameNS(DOMString? namespace, DOMString localName) Return the list of elements with namespace namespace and local name localName for.
HTMLCollection	getElementsByClassName(DOMString classNames) Return the list of elements with class names classNames for context object.
Element	insertAdjacentElement(DOMString where, Element element) Inserts a given element node at a given position relative to the element it is invoked upon.
void	insertAdjacentText(DOMString where, DOMString data) Inserts a given text node at a given position relative to the element it is invoked upon.
Element	closest(DOMString selectors) Returns the closest ancestor of the current element (or the current element itself) which matches the selectors given in parameter. If there isn’t such an ancestor, it returns null.
boolean	matches(DOMString selectors) Returns true if the element would be selected by the specified selector string; otherwise, returns false.
void	blur() Removes keyboard focus from this element.
void	focus() Gives keyboard focus to this element.
void	insertAdjacentHTML(DOMString position, DOMString text) Parses the specified text as HTML or XML and inserts the resulting nodes into the DOM tree at a specified position.
Element	querySelector(DOMString selectors) Returns the first element that is a descendant of the element on which it is invoked that matches the specified group of selectors.
NodeList	querySelectorAll(DOMString selectors) Returns a static (not live) NodeList of all elements descended from the element on which it is invoked that matches the specified group of CSS selectors. (The base element itself is not included, even if it matches.)
sequence< Animation >	getAnimations(optional GetAnimationsOptions options) Returns an array of all the Animation objects that the element has.
DOMRect	getBoundingClientRect() Returns the bounding rectangle of the element.
DOMRectList	getClientRects() Returns a collection of the bounding rectangles for each CSS border box in the element.
void	remove() Removes node Note: This should be part of the ChildNode interface.

Public Attributes inherited from Element

	Name
readonly attribute DOMString	tagName the element tag
readonly attribute DOMString	prefix Returns the namespace prefix of the specified element, or null if no prefix is specified.
readonly attribute DOMString	namespaceURI Returns the namespace URI of the element, or null if the element is not in a namespace.
readonly attribute DOMString	localName returns the local part of the qualified name of an element.
attribute DOMString	slot Returns the name of the shadow DOM slot attached to the element. A slot is a placeholder inside a web component that users can fill with their own markup.
attribute DOMString	id the id of the element
readonly attribute long	clientTop Returns the unscaled width of the top border of the element in pixels, ignoring any transforms.
readonly attribute long	clientLeft Returns the unscaled width of the left border of the element in pixels, ignoring any transforms.
readonly attribute long	clientWidth Returns the unscaled width of the padding box of the element, ignoring any transforms.
readonly attribute long	clientHeight Returns the unscaled height of the padding box of the element, ignoring any transforms.
readonly attribute NamedNodeMap	attributes Gets a list of all attributes for the Element.
readonly attribute NodeList	children A collection rooted at context object matching only element children. Note: This should be part of the ParentNode interface, which Element implements. Note: The return type should be HTMLCollection.
readonly attribute Element	firstElementChild attributes getter must return the first child that is an element, and null otherwise. Note: This should be part of the ParentNode interface, which Element
readonly attribute Element	lastElementChild attributes getter must return the last child that is an element, and null otherwise. Note: This should be part of the ParentNode interface, which Element
readonly attribute Element	previousElementSibling Returns the Element immediately prior to this node in its parent’s children list, or null if there is no Element in the list prior to this node. Note: This attribute is part of the NonDocumentTypeChildNode interface, which Element implements.
readonly attribute Element	nextElementSibling Returns the Element immediately following this node in its parent’s children list, or null if there is no Element in the list following this node. Note: This attribute is part of the NonDocumentTypeChildNode interface, which Element implements.
readonly attribute unsigned long	childElementCount attributes getter must return the number of children of context object that are elements. Note: This should be part of the ParentNode interface, which Element
attribute float	scrollLeft position of the horizontal scrollbar of the element
attribute float	scrollLeftVW scrollLeft in VW units The setter converts a given value into PX units based on viewport size
attribute float	scrollLeftVH scrollLeft in VH units The setter converts a given value into PX units based on viewport size
attribute float	scrollTop position of the vertical scrollbar of the element
attribute float	scrollTopVW scrollTop in VW units The setter converts a given value into PX units based on viewport size
attribute float	scrollTopVH scrollTop in VH units The setter converts a given value into PX units based on viewport size
readonly attribute long	scrollWidth size of the horizontal scrollbar of the element
readonly attribute long	scrollWidthVW scrollWidth converted to VW units
readonly attribute long	scrollWidthVH scrollWidth converted to VH units
readonly attribute long	scrollHeight size of the vertical scrollbar of the element
readonly attribute long	scrollHeightVW scrollHeight converted to VH units
readonly attribute long	scrollHeightVH scrollHeight converted to VH units
attribute DOMString	className all of the classes of the element
readonly attribute DOMTokenList	classList
attribute DOMString	innerHTML Gets or sets the contents of the element as HTML.
attribute DOMString	outerHTML Gets a fragment of HTML or XML that represents the element and its contents.
attribute EventSetter	focusin
attribute EventSetter	focusout
attribute EventSetter	abort
attribute EventSetter	blur
attribute EventSetter	click
attribute EventSetter	auxclick
attribute EventSetter	dblclick
attribute EventSetter	focus
attribute EventSetter	keydown
attribute EventSetter	keypress
attribute EventSetter	keyup
attribute EventSetter	mousedown
attribute EventSetter	mouseover
attribute EventSetter	mouseout
attribute EventSetter	mouseenter
attribute EventSetter	mouseleave
attribute EventSetter	mousemove
attribute EventSetter	mouseup
attribute EventSetter	input
attribute EventSetter	change
attribute EventSetter	scroll
attribute EventSetter	wheel
attribute EventSetter	touchstart
attribute EventSetter	touchend
attribute EventSetter	touchmove
attribute EventSetter	animationstart
attribute EventSetter	animationend
attribute EventSetter	animationcancel
attribute EventSetter	animationiteration
attribute EventSetter	transitionstart
attribute EventSetter	transitionend
attribute EventSetter	transitioncancel
attribute EventSetter	transitionrun

Public Functions inherited from Node

	Name
Node	removeChild(Node oldChild) remove a child node
Node	appendChild(Node newChild) append a node as a child
void	append((Node or DOMString)… newChildren) append nodes and string objects as children, where the string objects are inserted as equivalent Text nodes
Node	replaceChild(Node newChild, Node oldChild) replace oldChild with newChild
Node	insertBefore(Node node, Node? referenceNode) insert a node before the reference node, as a child of the current node
Node	cloneNode(optional boolean deep =false)
boolean	isEqualNode(Node? otherNode)
boolean	isSameNode(Node? otherNode)
boolean	hasChildNodes()
boolean	contains(Node? other)
DOMString	lookupPrefix(DOMString? namespace)
boolean	isDefaultNamespace(DOMString? namespace)
void	normalize()
unsigned short	compareDocumentPosition(Node other)
Node	getRootNode(optional GetRootNodeOptions options)
DOMString	lookupNamespaceURI(DOMString? prefix)

Public Attributes inherited from Node

	Name
const unsigned short	ELEMENT_NODE
const unsigned short	ATTRIBUTE_NODE
const unsigned short	TEXT_NODE
const unsigned short	CDATA_SECTION_NODE
const unsigned short	ENTITY_REFERENCE_NODE
const unsigned short	ENTITY_NODE
const unsigned short	PROCESSING_INSTRUCTION_NODE
const unsigned short	COMMENT_NODE
const unsigned short	DOCUMENT_NODE
const unsigned short	DOCUMENT_TYPE_NODE
const unsigned short	DOCUMENT_FRAGMENT_NODE
const unsigned short	NOTATION_NODE
const unsigned short	DOCUMENT_POSITION_DISCONNECTED
const unsigned short	DOCUMENT_POSITION_PRECEDING
const unsigned short	DOCUMENT_POSITION_FOLLOWING
const unsigned short	DOCUMENT_POSITION_CONTAINS
const unsigned short	DOCUMENT_POSITION_CONTAINED_BY
const unsigned short	DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly attribute DOMString	nodeName
attribute DOMString	nodeValue
attribute DOMString	textContent
readonly attribute unsigned short	nodeType type of the node
readonly attribute Node	parentNode parent of the node
readonly attribute Element	parentElement parent element of the node. If parent is not an Element, returns null.
readonly attribute NodeList	childNodes list of the children of this node
readonly attribute Node	firstChild the node’s first child in the tree, or null if the node is childless
readonly attribute Node	lastChild last child of the node, or null if there are no child elements
readonly attribute Node	previousSibling the node immediately preceding the specified one in its parent’s children, or null if the specified node is the first in that list
readonly attribute Node	nextSibling the node immediately following the specified one in its parent’s children, or null if the specified node is the last node in that list
readonly attribute Document	ownerDocument The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
readonly attribute USVString	baseURI
readonly attribute boolean	isConnected

Public Functions inherited from EventTarget

	Name
void	addEventListener(DOMInternedString type, EventListener listener, optional boolean useCapture)
void	removeEventListener(DOMInternedString type, EventListener listener, optional boolean useCapture)
boolean	dispatchEvent(Event event)

Public Functions Documentation

function cohPrebufferKeyframe

int cohPrebufferKeyframe(
    double timestamp
)

Prebuffers a keyframe for faster seek. Requires exact timestamp of the keyframe. Throws an error on failure.

Parameters:

timestamp timestamp of the keyframe in seconds

Return: a positive id if successful or negative value on failure

Note: Can only be used for videos containing metadata with keyframe information, support for partial requests and after readystate is greater than 1 (HAVE_METADATA)

function cohGetKeyframeTimestamps

sequence< double > cohGetKeyframeTimestamps()

Obtains the information for keyframe timestamps from video metadata.

Return: an array with keyframe timestamps in seconds

Note: Can only be used after readystate is greater than 1 (HAVE_METADATA)

function load

void load()

function canPlayType

CanPlayTypeEnum canPlayType(
    DOMString type
)

function play

void play()

function pause

void pause()

Public Attributes Documentation

variable cohFastSeek

attribute boolean cohFastSeek;

A boolean that controls the seek behavior When true the seek requests will seek to the nearest keyframe instead to a specific timepoint, which improves seek performance.

Note: When enabled, currentTime property will report the adjusted time, instead of the time previously set

variable error

readonly attribute MediaError error;

variable src

attribute DOMString src;

variable srcObject

attribute MediaSource srcObject;

variable currentSrc

readonly attribute DOMString currentSrc;

variable crossOrigin

attribute DOMString crossOrigin;

variable NETWORK_EMPTY

const unsigned short NETWORK_EMPTY = 0;

variable NETWORK_IDLE

const unsigned short NETWORK_IDLE = 1;

variable NETWORK_LOADING

const unsigned short NETWORK_LOADING = 2;

variable NETWORK_NO_SOURCE

const unsigned short NETWORK_NO_SOURCE = 3;

variable networkState

readonly attribute unsigned short networkState;

variable preload

attribute DOMString preload;

“none” or “auto” to preload keyframes for better seek performance

variable buffered

readonly attribute TimeRanges buffered;

variable HAVE_NOTHING

const unsigned short HAVE_NOTHING = 0;

variable HAVE_METADATA

const unsigned short HAVE_METADATA = 1;

variable HAVE_CURRENT_DATA

const unsigned short HAVE_CURRENT_DATA = 2;

variable HAVE_FUTURE_DATA

const unsigned short HAVE_FUTURE_DATA = 3;

variable HAVE_ENOUGH_DATA

const unsigned short HAVE_ENOUGH_DATA = 4;

variable readyState

readonly attribute unsigned short readyState;

variable seeking

readonly attribute boolean seeking;

variable currentTime

attribute double currentTime;

variable duration

readonly attribute unrestricted double duration;

variable paused

readonly attribute boolean paused;

variable defaultPlaybackRate

attribute double defaultPlaybackRate;

variable playbackRate

attribute double playbackRate;

variable played

readonly attribute TimeRanges played;

variable seekable

readonly attribute TimeRanges seekable;

variable ended

readonly attribute boolean ended;

variable autoplay

attribute boolean autoplay;

variable loop

attribute boolean loop;

variable volume

attribute double volume;

variable muted

attribute boolean muted;

variable durationchange

attribute EventSetter durationchange;

variable emptied

attribute EventSetter emptied;

variable ended

attribute EventSetter ended;

variable error

attribute EventSetter error;

variable loadstart

attribute EventSetter loadstart;

variable seeked

attribute EventSetter seeked;

variable seeking

attribute EventSetter seeking;

variable timeupdate

attribute EventSetter timeupdate;

variable volumechange

attribute EventSetter volumechange;

variable resize

attribute EventSetter resize;

HTMLMediaElement

Public Functions #

Public Attributes #

Additional inherited members #

Public Functions Documentation #

function cohPrebufferKeyframe #

function cohGetKeyframeTimestamps #

function load #

function canPlayType #

function play #

function pause #

Public Attributes Documentation #

variable cohFastSeek #

variable error #

variable src #

variable srcObject #

variable currentSrc #

variable crossOrigin #

variable NETWORK_EMPTY #

variable NETWORK_IDLE #

variable NETWORK_LOADING #

variable NETWORK_NO_SOURCE #

variable networkState #

variable preload #

variable buffered #

variable HAVE_NOTHING #

variable HAVE_METADATA #

variable HAVE_CURRENT_DATA #

variable HAVE_FUTURE_DATA #

variable HAVE_ENOUGH_DATA #

variable readyState #

variable seeking #

variable currentTime #

variable duration #

variable paused #

variable defaultPlaybackRate #

variable playbackRate #

variable played #

variable seekable #

variable ended #

variable autoplay #

variable loop #

variable volume #

variable muted #

variable durationchange #

variable emptied #

variable ended #

variable error #

variable loadstart #

variable seeked #

variable seeking #

variable timeupdate #

variable volumechange #

variable resize #

Public Functions

Public Attributes

Additional inherited members

Public Functions Documentation

function cohPrebufferKeyframe

function cohGetKeyframeTimestamps

function load

function canPlayType

function play

function pause

Public Attributes Documentation

variable cohFastSeek

variable error

variable src

variable srcObject

variable currentSrc

variable crossOrigin

variable NETWORK_EMPTY

variable NETWORK_IDLE

variable NETWORK_LOADING

variable NETWORK_NO_SOURCE

variable networkState

variable preload

variable buffered

variable HAVE_NOTHING

variable HAVE_METADATA

variable HAVE_CURRENT_DATA

variable HAVE_FUTURE_DATA

variable HAVE_ENOUGH_DATA

variable readyState

variable seeking

variable currentTime

variable duration

variable paused

variable defaultPlaybackRate

variable playbackRate

variable played

variable seekable

variable ended

variable autoplay

variable loop

variable volume

variable muted

variable durationchange

variable emptied

variable ended

variable error

variable loadstart

variable seeked

variable seeking

variable timeupdate

variable volumechange

variable resize