Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HTMLMediaElement

Adds to HTMLElement the properties and methods needed to support basic media-related capabilities that are common to audio and video.

Hierarchy

Index

Properties

Methods

Properties

ATTRIBUTE_NODE: number
CDATA_SECTION_NODE: number

node is a CDATASection node.

COMMENT_NODE: number

node is a Comment node.

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

DOCUMENT_NODE: number

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: number

Set when node and other are not in the same tree.

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

DOCUMENT_TYPE_NODE: number

node is a doctype.

ELEMENT_NODE: number

node is an element.

ENTITY_NODE: number
ENTITY_REFERENCE_NODE: number
HAVE_CURRENT_DATA: number
HAVE_ENOUGH_DATA: number
HAVE_FUTURE_DATA: number
HAVE_METADATA: number
HAVE_NOTHING: number
NETWORK_EMPTY: number
NETWORK_IDLE: number
NETWORK_LOADING: number
NETWORK_NO_SOURCE: number
NOTATION_NODE: number
PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

TEXT_NODE: number

node is a Text node.

accessKey: string
accessKeyLabel: string
assignedSlot: null | HTMLSlotElement
attributes: NamedNodeMap
autocapitalize: string
autofocus: boolean
autoplay: boolean

Gets or sets a value that indicates whether to start playing the media automatically.

baseURI: string

Returns node's node document's document base URL.

buffered: TimeRanges

Gets a collection of buffered time ranges.

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

children: HTMLCollection

Returns the child elements.

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

className: string

Returns the value of element's class content attribute. Can be set to change it.

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
contentEditable: string
controls: boolean

Gets or sets a flag that indicates whether the client provides a set of controls for the media (in case the developer does not include controls for the player).

crossOrigin: null | string
currentSrc: string

Gets the address or URL of the current media resource that is selected by IHTMLMediaElement.

currentTime: number

Gets or sets the current playback position, in seconds.

dataset: DOMStringMap
defaultMuted: boolean
defaultPlaybackRate: number

Gets or sets the default playback rate when the user is not using fast forward or reverse for a video or audio resource.

dir: string
draggable: boolean
duration: number

Returns the duration in seconds of the current media resource. A NaN value is returned if duration is not available, or Infinity if the media resource is streaming.

ended: boolean

Gets information about whether the playback has ended or not.

enterKeyHint: string
error: null | MediaError

Returns an object representing the current error state of the audio or video element.

firstChild: null | ChildNode

Returns the first child.

firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

hidden: boolean
id: string

Returns the value of element's id content attribute. Can be set to change it.

innerHTML: string
innerText: string
inputMode: string
isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable: boolean
lang: string
lastChild: null | ChildNode

Returns the last child.

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

localName: string

Returns the local name.

loop: boolean

Gets or sets a flag to specify whether playback should restart after it completes.

mediaKeys: null | MediaKeys
muted: boolean

Gets or sets a flag that indicates whether the audio (either audio or the audio track on video media) is muted.

namespaceURI: null | string

Returns the namespace.

networkState: number

Gets the current network activity for the element.

nextElementSibling: null | Element

Returns the first following sibling that is an element, and null otherwise.

nextSibling: null | ChildNode

Returns the next sibling.

nodeName: string

Returns a string appropriate for the type of node.

nodeType: number

Returns the type of node.

nodeValue: null | string
nonce?: string
offsetHeight: number
offsetLeft: number
offsetParent: null | Element
offsetTop: number
offsetWidth: number
onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)

Fires when the user aborts the download.

param ev

The event.

onanimationcancel: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationend: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationiteration: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationstart: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object loses the input focus.

param ev

The focus event.

oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is possible, but would require further buffering.

param ev

The event.

oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any)
onchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the contents of the object or selection have changed.

param ev

The event.

onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the left mouse button on the object

param ev

The mouse event.

onclose: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

param ev

The mouse event.

oncopy: null | ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any)
oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncut: null | ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any)
ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user double-clicks the object.

param ev

The mouse event.

ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object continuously during a drag operation.

param ev

The event.

ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

param ev

The event.

ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element when the user drags the object to a valid drop target.

param ev

The drag event.

ondragexit: null | ((this: GlobalEventHandlers, ev: Event) => any)
ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

param ev

The drag event.

ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

param ev

The event.

ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

param ev

The event.

ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)
ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration attribute is updated.

param ev

The event.

onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the media element is reset to its initial state.

param ev

The event.

onencrypted: null | ((this: HTMLMediaElement, ev: MediaEncryptedEvent) => any)
onended: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the end of playback is reached.

param ev

The event

Fires when an error occurs during object loading.

param ev

The event.

onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object receives focus.

param ev

The event.

onfullscreenchange: null | ((this: Element, ev: Event) => any)
onfullscreenerror: null | ((this: Element, ev: Event) => any)
ongotpointercapture: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
oninput: null | ((this: GlobalEventHandlers, ev: Event) => any)
oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any)
onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses a key.

param ev

The keyboard event

onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses an alphanumeric key.

param ev

The event.

onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user releases a key.

param ev

The keyboard event

onload: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires immediately after the browser loads the object.

param ev

The event.

onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when media data is loaded at the current playback position.

param ev

The event.

onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration and dimensions of the media have been determined.

param ev

The event.

onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when Internet Explorer begins looking for media data.

param ev

The event.

onlostpointercapture: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the object with either mouse button.

param ev

The mouse event.

onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse over the object.

param ev

The mouse event.

onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

param ev

The mouse event.

onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer into the object.

param ev

The mouse event.

onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user releases a mouse button while the mouse is over the object.

param ev

The mouse event.

onpaste: null | ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any)
onpause: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is paused.

param ev

The event.

onplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the play method is requested.

param ev

The event.

onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the audio or video has started playing.

param ev

The event.

onpointercancel: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerdown: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerenter: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerleave: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointermove: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerover: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any)

Occurs to indicate progress while downloading media data.

param ev

The event.

onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the playback rate is increased or decreased.

param ev

The event.

onreset: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user resets a form.

param ev

The event.

onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)
onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

param ev

The event.

onsecuritypolicyviolation: null | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any)
onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the seek operation ends.

param ev

The event.

onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the current playback position is moved.

param ev

The event.

onselect: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the current selection changes.

param ev

The event.

onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any)
onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the download has stopped.

param ev

The event.

onsubmit: null | ((this: GlobalEventHandlers, ev: Event) => any)
onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs if the load operation has been intentionally halted.

param ev

The event.

ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs to indicate the current playback position.

param ev

The event.

ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any)
ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontransitioncancel: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionend: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionrun: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionstart: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

param ev

The event.

onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback stops because the next frame of a video resource is not available.

param ev

The event.

onwaitingforkey: null | ((this: HTMLMediaElement, ev: Event) => any)
onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any)
outerHTML: string
ownerDocument: Document
parentElement: null | HTMLElement

Returns the parent element.

parentNode: null | Node & ParentNode

Returns the parent.

paused: boolean

Gets a flag that specifies whether playback is paused.

playbackRate: number

Gets or sets the current rate of speed for the media resource to play. This speed is expressed as a multiple of the normal speed of the media resource.

played: TimeRanges

Gets TimeRanges for the current media resource that has been played.

prefix: null | string

Returns the namespace prefix.

preload: string

Gets or sets the current playback position, in seconds.

previousElementSibling: null | Element

Returns the first preceding sibling that is an element, and null otherwise.

previousSibling: null | ChildNode

Returns the previous sibling.

readyState: number
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
seekable: TimeRanges

Returns a TimeRanges object that represents the ranges of the current media resource that can be seeked.

seeking: boolean

Gets a flag that indicates whether the client is currently moving to a new playback position in the media resource.

shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

spellcheck: boolean
src: string

The address or URL of the a media resource that is to be considered.

srcObject: null | Blob | MediaStream | MediaSource
style: CSSStyleDeclaration
tabIndex: number
tagName: string

Returns the HTML-uppercased qualified name.

textContent: null | string
textTracks: TextTrackList
title: string
translate: boolean
volume: number

Gets or sets the volume level for audio portions of the media element.

Methods

  • Type Parameters

    • K extends "invalid" | "error" | "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste" | "encrypted" | "waitingforkey"

    Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • kind: TextTrackKind
    • Optional label: string
    • Optional language: string

    Returns TextTrack

  • after(...nodes: (string | Node)[]): void
  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • append(...nodes: (string | Node)[]): void
  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • appendChild<T>(newChild: T): T
  • Type Parameters

    Parameters

    • newChild: T

    Returns T

  • Creates a shadow root for element and returns it.

    Parameters

    Returns ShadowRoot

  • before(...nodes: (string | Node)[]): void
  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • blur(): void
  • Returns void

  • Returns a string that specifies whether the client can play a given media resource type.

    Parameters

    • type: string

    Returns CanPlayTypeResult

  • click(): void
  • Returns void

  • cloneNode(deep?: boolean): Node
  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type Parameters

    • K extends "object" | "link" | "small" | "sub" | "sup" | "map" | "template" | "data" | "output" | "style" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

    Parameters

    • selector: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends "symbol" | "desc" | "filter" | "style" | "a" | "script" | "title" | "circle" | "clipPath" | "defs" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    Parameters

    • selector: string

    Returns null | E

  • compareDocumentPosition(other: Node): number
  • Returns a bitmask indicating the position of other relative to node.

    Parameters

    Returns number

  • contains(other: null | Node): boolean
  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    Returns boolean

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

  • fastSeek(time: number): void
  • Parameters

    • time: number

    Returns void

  • Parameters

    Returns void

  • Returns Animation[]

  • getAttribute(qualifiedName: string): null | string
  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    Parameters

    • qualifiedName: string

    Returns null | string

  • getAttributeNS(namespace: null | string, localName: string): null | string
  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

  • getAttributeNames(): string[]
  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

  • getAttributeNode(name: string): null | Attr
  • Parameters

    • name: string

    Returns null | Attr

  • getAttributeNodeNS(namespaceURI: string, localName: string): null | Attr
  • Parameters

    • namespaceURI: string
    • localName: string

    Returns null | Attr

  • Returns DOMRect

  • getClientRects(): DOMRectList
  • Returns DOMRectList

  • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

  • Type Parameters

    • K extends "object" | "link" | "small" | "sub" | "sup" | "map" | "template" | "data" | "output" | "style" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends "symbol" | "desc" | "filter" | "style" | "a" | "script" | "title" | "circle" | "clipPath" | "defs" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
  • getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Returns node's root.

    Parameters

    Returns Node

  • hasAttribute(qualifiedName: string): boolean
  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

  • hasAttributeNS(namespace: null | string, localName: string): boolean
  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

  • hasAttributes(): boolean
  • Returns true if element has attributes, and false otherwise.

    Returns boolean

  • hasChildNodes(): boolean
  • Returns whether node has children.

    Returns boolean

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    Returns null | Element

  • Parameters

    Returns void

  • Parameters

    Returns void

  • insertBefore<T>(newChild: T, refChild: null | Node): T
  • Type Parameters

    Parameters

    • newChild: T
    • refChild: null | Node

    Returns T

  • isDefaultNamespace(namespace: null | string): boolean
  • Parameters

    • namespace: null | string

    Returns boolean

  • isEqualNode(otherNode: null | Node): boolean
  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

  • isSameNode(otherNode: null | Node): boolean
  • Parameters

    • otherNode: null | Node

    Returns boolean

  • load(): void
  • Resets the audio or video object and loads a new media resource.

    Returns void

  • lookupNamespaceURI(prefix: null | string): null | string
  • Parameters

    • prefix: null | string

    Returns null | string

  • lookupPrefix(namespace: null | string): null | string
  • Parameters

    • namespace: null | string

    Returns null | string

  • matches(selectors: string): boolean
  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

  • msGetRegionContent(): any
  • Returns any

  • normalize(): void
  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    Returns void

  • pause(): void
  • Pauses the current playback and sets paused to TRUE. This can be used to test whether the media is playing or paused. You can also use the pause or play events to tell whether the media is playing or not.

    Returns void

  • play(): Promise<void>
  • Loads and starts playback of a media resource.

    Returns Promise<void>

  • prepend(...nodes: (string | Node)[]): void
  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Returns the first element that is a descendant of node that matches selectors.

    Type Parameters

    • K extends "object" | "link" | "small" | "sub" | "sup" | "map" | "template" | "data" | "output" | "style" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

    Parameters

    • selectors: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends "symbol" | "desc" | "filter" | "style" | "a" | "script" | "title" | "circle" | "clipPath" | "defs" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    Parameters

    • selectors: string

    Returns null | E

  • Returns all element descendants of node that match selectors.

    Type Parameters

    • K extends "object" | "link" | "small" | "sub" | "sup" | "map" | "template" | "data" | "output" | "style" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends "symbol" | "desc" | "filter" | "style" | "a" | "script" | "title" | "circle" | "clipPath" | "defs" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    Parameters

    • selectors: string

    Returns NodeListOf<E>

  • releasePointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

  • remove(): void
  • Removes node.

    Returns void

  • removeAttribute(qualifiedName: string): void
  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

  • removeAttributeNS(namespace: null | string, localName: string): void
  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

  • Parameters

    Returns Attr

  • removeChild<T>(oldChild: T): T
  • Type Parameters

    Parameters

    • oldChild: T

    Returns T

  • Type Parameters

    • K extends "invalid" | "error" | "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste" | "encrypted" | "waitingforkey"

    Parameters

    Returns void

  • Parameters

    Returns void

  • replaceChild<T>(newChild: Node, oldChild: T): T
  • Type Parameters

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

  • replaceWith(...nodes: (string | Node)[]): void
  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    Parameters

    Returns Promise<void>

  • requestPointerLock(): void
  • Returns void

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void
  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    Returns void

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void
  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • setAttribute(qualifiedName: string, value: string): void
  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

  • setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void
  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

  • setAttributeNode(attr: Attr): null | Attr
  • Parameters

    Returns null | Attr

  • setAttributeNodeNS(attr: Attr): null | Attr
  • Parameters

    Returns null | Attr

  • setMediaKeys(mediaKeys: null | MediaKeys): Promise<void>
  • Parameters

    Returns Promise<void>

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean
  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

    Returns true if qualifiedName is now present, and false otherwise.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

  • webkitMatchesSelector(selectors: string): boolean
  • Parameters

    • selectors: string

    Returns boolean

Generated using TypeDoc