Interface: HTMLMediaElement

Defined in: types/desktop-engine.d.ts:5257

An audio player with the API of browsers' media elements. It isn't in a document: attributes are plain values, and preload, crossOrigin, defaultMuted, defaultPlaybackRate and preservesPitch are kept but not used. Playing elements aren't collected before they end

Extends

• EventTarget

Extended by

• HTMLAudioElement

Properties

autoplay

autoplay: boolean;

Defined in: types/desktop-engine.d.ts:5265

Plays once it can

---

buffered

readonly buffered: TimeRanges;

Defined in: types/desktop-engine.d.ts:5284

---

crossOrigin

crossOrigin: string | null;

Defined in: types/desktop-engine.d.ts:5289

---

currentSrc

readonly currentSrc: string;

Defined in: types/desktop-engine.d.ts:5263

---

currentTime

currentTime: number;

Defined in: types/desktop-engine.d.ts:5273

Setting it seeks

---

defaultMuted

defaultMuted: boolean;

Defined in: types/desktop-engine.d.ts:5290

---

defaultPlaybackRate

defaultPlaybackRate: number;

Defined in: types/desktop-engine.d.ts:5291

---

duration

readonly duration: number;

Defined in: types/desktop-engine.d.ts:5275

NaN until the metadata has loaded

---

ended

readonly ended: boolean;

Defined in: types/desktop-engine.d.ts:5277

---

error

readonly error: MediaError | null;

Defined in: types/desktop-engine.d.ts:5283

---

HAVE_CURRENT_DATA

readonly HAVE_CURRENT_DATA: 2;

Defined in: types/desktop-engine.d.ts:5338

---

HAVE_ENOUGH_DATA

readonly HAVE_ENOUGH_DATA: 4;

Defined in: types/desktop-engine.d.ts:5340

---

HAVE_FUTURE_DATA

readonly HAVE_FUTURE_DATA: 3;

Defined in: types/desktop-engine.d.ts:5339

---

HAVE_METADATA

readonly HAVE_METADATA: 1;

Defined in: types/desktop-engine.d.ts:5337

---

HAVE_NOTHING

readonly HAVE_NOTHING: 0;

Defined in: types/desktop-engine.d.ts:5336

---

loop

loop: boolean;

Defined in: types/desktop-engine.d.ts:5266

---

muted

muted: boolean;

Defined in: types/desktop-engine.d.ts:5267

---

NETWORK_EMPTY

readonly NETWORK_EMPTY: 0;

Defined in: types/desktop-engine.d.ts:5341

---

NETWORK_IDLE

readonly NETWORK_IDLE: 1;

Defined in: types/desktop-engine.d.ts:5342

---

NETWORK_LOADING

readonly NETWORK_LOADING: 2;

Defined in: types/desktop-engine.d.ts:5343

---

NETWORK_NO_SOURCE

readonly NETWORK_NO_SOURCE: 3;

Defined in: types/desktop-engine.d.ts:5344

---

networkState

readonly networkState: 0 | 1 | 2 | 3;

Defined in: types/desktop-engine.d.ts:5282

NETWORK_EMPTY ... NETWORK_NO_SOURCE

---

onabort

onabort: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5310

---

oncanplay

oncanplay: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5311

---

oncanplaythrough

oncanplaythrough: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5312

---

ondurationchange

ondurationchange: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5313

---

onemptied

onemptied: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5314

---

onended

onended: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5315

---

onerror

onerror: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5316

---

onloadeddata

onloadeddata: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5317

---

onloadedmetadata

onloadedmetadata: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5318

---

onloadstart

onloadstart: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5319

---

onpause

onpause: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5320

---

onplay

onplay: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5321

---

onplaying

onplaying: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5322

---

onprogress

onprogress: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5323

---

onratechange

onratechange: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5324

---

onseeked

onseeked: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5325

---

onseeking

onseeking: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5326

---

onstalled

onstalled: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5327

---

onsuspend

onsuspend: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5328

---

ontimeupdate

ontimeupdate: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5329

---

onvolumechange

onvolumechange: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5330

---

onwaiting

onwaiting: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5331

---

paused

readonly paused: boolean;

Defined in: types/desktop-engine.d.ts:5276

---

playbackRate

playbackRate: number;

Defined in: types/desktop-engine.d.ts:5271

0 to 16

---

played

readonly played: TimeRanges;

Defined in: types/desktop-engine.d.ts:5287

Always empty

---

preload

preload: string;

Defined in: types/desktop-engine.d.ts:5288

---

preservesPitch

preservesPitch: boolean;

Defined in: types/desktop-engine.d.ts:5292

---

readyState

readonly readyState: 0 | 1 | 2 | 3 | 4;

Defined in: types/desktop-engine.d.ts:5280

HAVE_NOTHING ... HAVE_ENOUGH_DATA

---

seekable

readonly seekable: TimeRanges;

Defined in: types/desktop-engine.d.ts:5285

---

seeking

readonly seeking: boolean;

Defined in: types/desktop-engine.d.ts:5278

---

src

src: string;

Defined in: types/desktop-engine.d.ts:5262

A package file (resolved like require) or, with the "network" permission, an http(s) URL; no data: URLs. Setting it loads

---

volume

volume: number;

Defined in: types/desktop-engine.d.ts:5269

0 to 1

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:5332

A boolean options (capture) is ignored

Type Parameters

Type Parameter
K extends keyof HTMLMediaElementEventMap

Parameters

Parameter	Type
type	K
listener	(this, event) => void
options?	| boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Call Signature

addEventListener(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:5333

A boolean options (capture) is ignored

Parameters

Parameter	Type
type	string
listener	| EventListenerOrEventListenerObject | null
options?	| boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

---

canPlayType()

canPlayType(type): "" | "maybe" | "probably";

Defined in: types/desktop-engine.d.ts:5304

"probably", "maybe" or "" for a MIME type, e.g. "audio/mpeg"

Parameters

Parameter	Type
type	string

Returns

"" | "maybe" | "probably"

---

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: types/desktop-engine.d.ts:3937

Returns false when a listener called preventDefault() on a cancelable event

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

---

fastSeek()

fastSeek(time): void;

Defined in: types/desktop-engine.d.ts:5302

Seeks, after the metadata has loaded if it hasn't yet

Parameters

Parameter	Type
time	number

Returns

void

---

getAttribute()

getAttribute(name): string | null;

Defined in: types/desktop-engine.d.ts:5307

Parameters

Parameter	Type
name	string

Returns

string | null

---

hasAttribute()

hasAttribute(name): boolean;

Defined in: types/desktop-engine.d.ts:5309

Parameters

Parameter	Type
name	string

Returns

boolean

---

load()

load(): void;

Defined in: types/desktop-engine.d.ts:5294

Stops and loads src again; a pending play() rejects with an "AbortError" DOMException

Returns

void

---

pause()

pause(): void;

Defined in: types/desktop-engine.d.ts:5300

Returns

void

---

play()

play(): Promise<void>;

Defined in: types/desktop-engine.d.ts:5299

Loads if needed and resolves once playing. Rejects with a "NotAllowedError" DOMException without the "audio" permission, "NotSupportedError" when the source can't be loaded or decoded, "AbortError" after pause() or load()

Returns

Promise<void>

---

removeAttribute()

removeAttribute(name): void;

Defined in: types/desktop-engine.d.ts:5308

Parameters

Parameter	Type
name	string

Returns

void

---

removeEventListener()

Call Signature

removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:5334

Type Parameters

Type Parameter
K extends keyof HTMLMediaElementEventMap

Parameters

Parameter	Type
type	K
listener	(this, event) => void

Returns

void

Overrides

EventTarget.removeEventListener

Call Signature

removeEventListener(type, listener): void;

Defined in: types/desktop-engine.d.ts:5335

Parameters

Parameter	Type
type	string
listener	| EventListenerOrEventListenerObject | null

Returns

void

Overrides

EventTarget.removeEventListener

---

setAttribute()

setAttribute(name, value): void;

Defined in: types/desktop-engine.d.ts:5306

"src", "autoplay", "loop" and "muted" set the properties

Parameters

Parameter	Type
name	string
value	string

Returns

void