Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HTMLVideoElement

Package version

Provides special properties and methods for manipulating video objects. It also inherits properties and methods of HTMLMediaElement and HTMLElement.

Hierarchy

Index

Properties

Methods

Properties

ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

ENTITY_NODE

ENTITY_NODE: number

ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

HAVE_CURRENT_DATA

HAVE_CURRENT_DATA: number

HAVE_ENOUGH_DATA

HAVE_ENOUGH_DATA: number

HAVE_FUTURE_DATA

HAVE_FUTURE_DATA: number

HAVE_METADATA

HAVE_METADATA: number

HAVE_NOTHING

HAVE_NOTHING: number

HTMLMediaElement

HTMLMediaElement: { constructor: any; 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; prototype: HTMLMediaElement }

Type declaration

  • constructor: function
    • Returns HTMLMediaElement

  • 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
  • prototype: HTMLMediaElement

NETWORK_EMPTY

NETWORK_EMPTY: number

NETWORK_IDLE

NETWORK_IDLE: number

NETWORK_LOADING

NETWORK_LOADING: number

NETWORK_NO_SOURCE

NETWORK_NO_SOURCE: number

NOTATION_NODE

NOTATION_NODE: number

PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

accessKeyLabel

accessKeyLabel: string

assignedSlot

assignedSlot: HTMLSlotElement | null

attributes

attributes: NamedNodeMap

audioTracks

audioTracks: AudioTrackList

Returns an AudioTrackList object with the audio tracks for a given video element.

autocapitalize

autocapitalize: string

autoplay

autoplay: boolean

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

baseURI

baseURI: string

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

buffered

buffered: TimeRanges

Gets a collection of buffered time ranges.

childElementCount

childElementCount: number

childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

children

children: HTMLCollection

Returns the child elements.

classList

classList: DOMTokenList

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

className

className: string

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

clientHeight

clientHeight: number

clientLeft

clientLeft: number

clientTop

clientTop: number

clientWidth

clientWidth: number

contentEditable

contentEditable: string

controls

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

crossOrigin: string | null

currentSrc

currentSrc: string

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

currentTime

currentTime: number

Gets or sets the current playback position, in seconds.

dataset

dataset: DOMStringMap

defaultMuted

defaultMuted: boolean

defaultPlaybackRate

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

dir: string

draggable

draggable: boolean

duration

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

ended: boolean

Gets information about whether the playback has ended or not.

error

error: MediaError | null

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

firstChild

firstChild: ChildNode | null

Returns the first child.

firstElementChild

firstElementChild: Element | null

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

height

height: number

Gets or sets the height of the video element.

hidden

hidden: boolean

id

id: string

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

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable

isContentEditable: boolean

lang

lang: string

lastChild

lastChild: ChildNode | null

Returns the last child.

lastElementChild

lastElementChild: Element | null

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

localName

localName: string

Returns the local name.

loop

loop: boolean

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

mediaKeys

mediaKeys: MediaKeys | null

msAudioCategory

msAudioCategory: string

Specifies the purpose of the audio or video media, such as background audio or alerts.

msAudioDeviceType

msAudioDeviceType: string

Specifies the output device id that the audio will be sent to.

msGraphicsTrustStatus

msGraphicsTrustStatus: MSGraphicsTrust

msHorizontalMirror

msHorizontalMirror: boolean

msIsLayoutOptimalForPlayback

msIsLayoutOptimalForPlayback: boolean

msIsStereo3D

msIsStereo3D: boolean

msKeys

msKeys: MSMediaKeys
deprecated

msPlayToDisabled

msPlayToDisabled: boolean

Gets or sets whether the DLNA PlayTo device is available.

msPlayToPreferredSourceUri

msPlayToPreferredSourceUri: string

Gets or sets the path to the preferred media source. This enables the Play To target device to stream the media content, which can be DRM protected, from a different location, such as a cloud media server.

msPlayToPrimary

msPlayToPrimary: boolean

Gets or sets the primary DLNA PlayTo device.

msPlayToSource

msPlayToSource: any

Gets the source associated with the media element for use by the PlayToManager.

msRealTime

msRealTime: boolean

Specifies whether or not to enable low-latency playback on the media element.

msStereo3DPackingMode

msStereo3DPackingMode: string

msStereo3DRenderMode

msStereo3DRenderMode: string

msZoom

msZoom: boolean

muted

muted: boolean

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

namespaceURI

namespaceURI: string | null

Returns the namespace.

networkState

networkState: number

Gets the current network activity for the element.

nextElementSibling

nextElementSibling: Element | null

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

nextSibling

nextSibling: ChildNode | null

Returns the next sibling.

nodeName

nodeName: string

Returns a string appropriate for the type of node.

nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: string | null

Optional nonce

nonce: undefined | string

offsetHeight

offsetHeight: number

offsetLeft

offsetLeft: number

offsetParent

offsetParent: Element | null

offsetTop

offsetTop: number

offsetWidth

offsetWidth: number

onMSVideoFormatChanged

onMSVideoFormatChanged: ((this: HTMLVideoElement, ev: Event) => any) | null

onMSVideoFrameStepCompleted

onMSVideoFrameStepCompleted: ((this: HTMLVideoElement, ev: Event) => any) | null

onMSVideoOptimalLayoutChanged

onMSVideoOptimalLayoutChanged: ((this: HTMLVideoElement, ev: Event) => any) | null

onabort

onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null

Fires when the user aborts the download.

param

The event.

onanimationcancel

onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onanimationend

onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onanimationiteration

onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onanimationstart

onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onauxclick

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

onblur

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

Fires when the object loses the input focus.

param

The focus event.

oncancel

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

oncanplay

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

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

param

The event.

oncanplaythrough

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

onchange

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

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

param

The event.

onclick

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

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

param

The mouse event.

onclose

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

oncontextmenu

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

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

param

The mouse event.

oncopy

oncopy: ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any) | null

oncuechange

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

oncut

oncut: ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any) | null

ondblclick

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

Fires when the user double-clicks the object.

param

The mouse event.

ondrag

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

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

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

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

param

The event.

ondragenter

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

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

param

The drag event.

ondragexit

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

ondragleave

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

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

param

The drag event.

ondragover

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

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

param

The event.

ondragstart

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

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

param

The event.

ondrop

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

ondurationchange

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

Occurs when the duration attribute is updated.

param

The event.

onemptied

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

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

param

The event.

onencrypted

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

onended

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

Occurs when the end of playback is reached.

param

The event

onerror

Fires when an error occurs during object loading.

param

The event.

onfocus

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

Fires when the object receives focus.

param

The event.

onfullscreenchange

onfullscreenchange: ((this: Element, ev: Event) => any) | null

onfullscreenerror

onfullscreenerror: ((this: Element, ev: Event) => any) | null

ongotpointercapture

ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

oninput

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

oninvalid

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

onkeydown

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

Fires when the user presses a key.

param

The keyboard event

onkeypress

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

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

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

Fires when the user releases a key.

param

The keyboard event

onload

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

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

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

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

param

The event.

onloadedmetadata

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

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

param

The event.

onloadend

onloadend: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

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

onmousedown

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

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

param

The mouse event.

onmouseenter

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

onmouseleave

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

onmousemove

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

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

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

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

param

The mouse event.

onmouseover

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

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

param

The mouse event.

onmouseup

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

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

param

The mouse event.

onmsneedkey

onmsneedkey: ((this: HTMLMediaElement, ev: Event) => any) | null
deprecated

onpaste

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

onpause

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

Occurs when playback is paused.

param

The event.

onplay

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

Occurs when the play method is requested.

param

The event.

onplaying

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

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerdown

onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerenter

onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerleave

onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointermove

onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerout

onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerover

onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerup

onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onprogress

onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

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

Occurs when the playback rate is increased or decreased.

param

The event.

onreset

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

Fires when the user resets a form.

param

The event.

onresize

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

onscroll

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

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

param

The event.

onsecuritypolicyviolation

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

onseeked

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

Occurs when the seek operation ends.

param

The event.

onseeking

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

Occurs when the current playback position is moved.

param

The event.

onselect

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

Fires when the current selection changes.

param

The event.

onselectionchange

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

onselectstart

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

onstalled

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

Occurs when the download has stopped.

param

The event.

onsubmit

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

onsuspend

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

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

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

Occurs to indicate the current playback position.

param

The event.

ontoggle

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

ontouchcancel

ontouchcancel: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null

ontouchend

ontouchend: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null

ontouchmove

ontouchmove: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null

ontouchstart

ontouchstart: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null

ontransitioncancel

ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

ontransitionend

ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

ontransitionrun

ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

ontransitionstart

ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

onvolumechange

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

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

param

The event.

onwaiting

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

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

param

The event.

onwaitingforkey

onwaitingforkey: ((this: HTMLMediaElement, ev: Event) => any) | null

onwheel

onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null

outerHTML

outerHTML: string

ownerDocument

ownerDocument: Document | null

Returns the node document. Returns null for documents.

parentElement

parentElement: HTMLElement | null

Returns the parent element.

parentNode

parentNode: (Node & ParentNode) | null

Returns the parent.

paused

paused: boolean

Gets a flag that specifies whether playback is paused.

playbackRate

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

played: TimeRanges

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

poster

poster: string

Gets or sets a URL of an image to display, for example, like a movie poster. This can be a still frame from the video, or another image if no video data is available.

prefix

prefix: string | null

Returns the namespace prefix.

preload

preload: string

Gets or sets the current playback position, in seconds.

previousElementSibling

previousElementSibling: Element | null

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

previousSibling

previousSibling: Node | null

Returns the previous sibling.

readyState

readyState: number

scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

scrollWidth

scrollWidth: number

seekable

seekable: TimeRanges

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

seeking

seeking: boolean

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

shadowRoot

shadowRoot: ShadowRoot | null

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

slot

slot: string

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

spellcheck

spellcheck: boolean

src

src: string

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

srcObject

srcObject: MediaStream | MediaSource | Blob | null

style

tabIndex

tabIndex: number

tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string | null

textTracks

textTracks: TextTrackList

title

title: string

translate

translate: boolean

videoHeight

videoHeight: number

Gets the intrinsic height of a video in CSS pixels, or zero if the dimensions are not known.

videoTracks

videoTracks: VideoTrackList

videoWidth

videoWidth: number

Gets the intrinsic width of a video in CSS pixels, or zero if the dimensions are not known.

volume

volume: number

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

webkitDisplayingFullscreen

webkitDisplayingFullscreen: boolean

webkitSupportsFullscreen

webkitSupportsFullscreen: boolean

width

width: number

Gets or sets the width of the video element.

Methods

addEventListener

addTextTrack

  • Parameters

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

    Returns TextTrack

after

  • 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

animate

append

  • 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

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

    Parameters

    • newChild: T

    Returns T

attachShadow

  • Creates a shadow root for element and returns it.

    Parameters

    Returns ShadowRoot

before

  • 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

  • blur(): void
  • Returns void

canPlayType

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

    Parameters

    • type: string

    Returns CanPlayTypeResult

click

  • click(): void
  • Returns void

cloneNode

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

    Parameters

    • Optional deep: undefined | false | true

    Returns Node

closest

  • closest<K>(selector: K): HTMLElementTagNameMap[K] | null
  • closest<K>(selector: K): SVGElementTagNameMap[K] | null
  • closest<E>(selector: string): E | null
  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    Parameters

    • selector: string

    Returns E | null

compareDocumentPosition

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

    Parameters

    Returns number

contains

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

    Parameters

    • other: Node | null

    Returns boolean

dispatchEvent

  • 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

focus

  • Parameters

    Returns void

getAnimations

  • Returns Animation[]

getAttribute

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

    Parameters

    • qualifiedName: string

    Returns string | null

getAttributeNS

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns string | null

getAttributeNames

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

    Returns string[]

getAttributeNode

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

    • name: string

    Returns Attr | null

getAttributeNodeNS

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

    • namespaceURI: string
    • localName: string

    Returns Attr | null

getBoundingClientRect

  • Returns DOMRect

getClientRects

  • Returns DOMRectList

getElementsByClassName

  • 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>

getElementsByTagName

getElementsByTagNameNS

getRootNode

  • Returns node's root.

    Parameters

    Returns Node

getVideoPlaybackQuality

  • Returns VideoPlaybackQuality

hasAttribute

  • 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

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns boolean

hasAttributes

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

    Returns boolean

hasChildNodes

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

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

insertAdjacentHTML

  • Parameters

    Returns void

insertAdjacentText

  • Parameters

    Returns void

insertBefore

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

    Parameters

    • newChild: T
    • refChild: Node | null

    Returns T

isDefaultNamespace

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

    • namespace: string | null

    Returns boolean

isEqualNode

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

    Parameters

    • otherNode: Node | null

    Returns boolean

isSameNode

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

    • otherNode: Node | null

    Returns boolean

load

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

    Returns void

lookupNamespaceURI

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

    • prefix: string | null

    Returns string | null

lookupPrefix

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

    • namespace: string | null

    Returns string | null

matches

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

    Parameters

    • selectors: string

    Returns boolean

msClearEffects

  • msClearEffects(): void
  • Clears all effects from the media pipeline.

    Returns void

msFrameStep

  • msFrameStep(forward: boolean): void
  • Parameters

    • forward: boolean

    Returns void

msGetAsCastingSource

  • msGetAsCastingSource(): any
  • Returns any

msGetRegionContent

  • msGetRegionContent(): any
  • Returns any

msInsertAudioEffect

  • msInsertAudioEffect(activatableClassId: string, effectRequired: boolean, config?: any): void
  • Inserts the specified audio effect into media pipeline.

    Parameters

    • activatableClassId: string
    • effectRequired: boolean
    • Optional config: any

    Returns void

msInsertVideoEffect

  • msInsertVideoEffect(activatableClassId: string, effectRequired: boolean, config?: any): void
  • Parameters

    • activatableClassId: string
    • effectRequired: boolean
    • Optional config: any

    Returns void

msSetMediaKeys

  • deprecated

    Parameters

    Returns void

msSetMediaProtectionManager

  • msSetMediaProtectionManager(mediaProtectionManager?: any): void
  • Specifies the media protection manager for a given media pipeline.

    Parameters

    • Optional mediaProtectionManager: any

    Returns void

msSetVideoRectangle

  • msSetVideoRectangle(left: number, top: number, right: number, bottom: number): void
  • Parameters

    • left: number
    • top: number
    • right: number
    • bottom: number

    Returns void

normalize

  • 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

  • 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

  • Loads and starts playback of a media resource.

    Returns Promise<void>

prepend

  • 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

querySelector

  • querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null
  • querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null
  • querySelector<E>(selectors: string): E | null
  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    Parameters

    • selectors: string

    Returns E | null

querySelectorAll

  • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
  • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
  • querySelectorAll<E>(selectors: string): NodeListOf<E>
  • Returns all element descendants of node that match selectors.

    Type parameters

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void
  • Removes node.

    Returns void

removeAttribute

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

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns void

removeAttributeNode

  • Parameters

    Returns Attr

removeChild

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

    Parameters

    • oldChild: T

    Returns T

removeEventListener

replaceChild

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

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

replaceWith

  • 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

requestFullscreen

  • 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

  • requestPointerLock(): void
  • Returns void

scroll

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

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

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

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • Parameters

    Returns void

scrollTo

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

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • 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

  • setAttributeNS(namespace: string | null, 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: string | null
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

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

    Returns Attr | null

setAttributeNodeNS

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

    Returns Attr | null

setMediaKeys

  • Parameters

    Returns Promise<void>

setPointerCapture

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: undefined | false | true): 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: undefined | false | true

    Returns boolean

webkitEnterFullScreen

  • webkitEnterFullScreen(): void
  • Returns void

webkitEnterFullscreen

  • webkitEnterFullscreen(): void
  • Returns void

webkitExitFullScreen

  • webkitExitFullScreen(): void
  • Returns void

webkitExitFullscreen

  • webkitExitFullscreen(): void
  • Returns void

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean
  • Parameters

    • selectors: string

    Returns boolean

Generated using TypeDoc