DesktopEngine SDK

English

简体中文

English

简体中文

Appearance

Interface: HTMLAudioElement ​

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

An audio element, made with new Audio(src)

Extends ​

Properties ​

autoplay ​

ts
autoplay: boolean;

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

Plays once it can

Inherited from ​

HTMLMediaElement.autoplay

buffered ​

ts
readonly buffered: TimeRanges;

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

Inherited from ​

HTMLMediaElement.buffered

crossOrigin ​

ts
crossOrigin: string | null;

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

Inherited from ​

HTMLAudioElement.crossOrigin

currentSrc ​

ts
readonly currentSrc: string;

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

Inherited from ​

HTMLMediaElement.currentSrc

currentTime ​

ts
currentTime: number;

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

Setting it seeks

Inherited from ​

HTMLMediaElement.currentTime

defaultMuted ​

ts
defaultMuted: boolean;

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

Inherited from ​

HTMLMediaElement.defaultMuted

defaultPlaybackRate ​

ts
defaultPlaybackRate: number;

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

Inherited from ​

HTMLMediaElement.defaultPlaybackRate

duration ​

ts
readonly duration: number;

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

NaN until the metadata has loaded

Inherited from ​

HTMLMediaElement.duration

ended ​

ts
readonly ended: boolean;

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

Inherited from ​

HTMLMediaElement.ended

error ​

ts
readonly error: MediaError | null;

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

Inherited from ​

HTMLAudioElement.error

HAVE_CURRENT_DATA ​

ts
readonly HAVE_CURRENT_DATA: 2;

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

Inherited from ​

HTMLMediaElement.HAVE_CURRENT_DATA

HAVE_ENOUGH_DATA ​

ts
readonly HAVE_ENOUGH_DATA: 4;

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

Inherited from ​

HTMLMediaElement.HAVE_ENOUGH_DATA

HAVE_FUTURE_DATA ​

ts
readonly HAVE_FUTURE_DATA: 3;

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

Inherited from ​

HTMLMediaElement.HAVE_FUTURE_DATA

HAVE_METADATA ​

ts
readonly HAVE_METADATA: 1;

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

Inherited from ​

HTMLMediaElement.HAVE_METADATA

HAVE_NOTHING ​

ts
readonly HAVE_NOTHING: 0;

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

Inherited from ​

HTMLMediaElement.HAVE_NOTHING

loop ​

ts
loop: boolean;

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

Inherited from ​

HTMLMediaElement.loop

muted ​

ts
muted: boolean;

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

Inherited from ​

HTMLMediaElement.muted

NETWORK_EMPTY ​

ts
readonly NETWORK_EMPTY: 0;

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

Inherited from ​

HTMLMediaElement.NETWORK_EMPTY

NETWORK_IDLE ​

ts
readonly NETWORK_IDLE: 1;

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

Inherited from ​

HTMLMediaElement.NETWORK_IDLE

NETWORK_LOADING ​

ts
readonly NETWORK_LOADING: 2;

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

Inherited from ​

HTMLMediaElement.NETWORK_LOADING

NETWORK_NO_SOURCE ​

ts
readonly NETWORK_NO_SOURCE: 3;

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

Inherited from ​

HTMLMediaElement.NETWORK_NO_SOURCE

networkState ​

ts
readonly networkState: 0 | 1 | 2 | 3;

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

NETWORK_EMPTY ... NETWORK_NO_SOURCE

Inherited from ​

HTMLAudioElement.networkState

onabort ​

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

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

Inherited from ​

HTMLMediaElement.onabort

oncanplay ​

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

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

Inherited from ​

HTMLMediaElement.oncanplay

oncanplaythrough ​

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

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

Inherited from ​

HTMLMediaElement.oncanplaythrough

ondurationchange ​

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

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

Inherited from ​

HTMLMediaElement.ondurationchange

onemptied ​

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

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

Inherited from ​

HTMLMediaElement.onemptied

onended ​

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

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

Inherited from ​

HTMLMediaElement.onended

onerror ​

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

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

Inherited from ​

HTMLMediaElement.onerror

onloadeddata ​

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

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

Inherited from ​

HTMLMediaElement.onloadeddata

onloadedmetadata ​

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

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

Inherited from ​

HTMLMediaElement.onloadedmetadata

onloadstart ​

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

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

Inherited from ​

HTMLMediaElement.onloadstart

onpause ​

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

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

Inherited from ​

HTMLMediaElement.onpause

onplay ​

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

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

Inherited from ​

HTMLMediaElement.onplay

onplaying ​

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

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

Inherited from ​

HTMLMediaElement.onplaying

onprogress ​

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

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

Inherited from ​

HTMLMediaElement.onprogress

onratechange ​

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

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

Inherited from ​

HTMLMediaElement.onratechange

onseeked ​

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

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

Inherited from ​

HTMLMediaElement.onseeked

onseeking ​

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

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

Inherited from ​

HTMLMediaElement.onseeking

onstalled ​

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

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

Inherited from ​

HTMLMediaElement.onstalled

onsuspend ​

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

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

Inherited from ​

HTMLMediaElement.onsuspend

ontimeupdate ​

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

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

Inherited from ​

HTMLMediaElement.ontimeupdate

onvolumechange ​

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

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

Inherited from ​

HTMLMediaElement.onvolumechange

onwaiting ​

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

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

Inherited from ​

HTMLMediaElement.onwaiting

paused ​

ts
readonly paused: boolean;

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

Inherited from ​

HTMLMediaElement.paused

playbackRate ​

ts
playbackRate: number;

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

0 to 16

Inherited from ​

HTMLMediaElement.playbackRate

played ​

ts
readonly played: TimeRanges;

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

Always empty

Inherited from ​

HTMLMediaElement.played

preload ​

ts
preload: string;

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

Inherited from ​

HTMLMediaElement.preload

preservesPitch ​

ts
preservesPitch: boolean;

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

Inherited from ​

HTMLMediaElement.preservesPitch

readyState ​

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

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

HAVE_NOTHING ... HAVE_ENOUGH_DATA

Inherited from ​

HTMLAudioElement.readyState

seekable ​

ts
readonly seekable: TimeRanges;

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

Inherited from ​

HTMLMediaElement.seekable

seeking ​

ts
readonly seeking: boolean;

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

Inherited from ​

HTMLMediaElement.seeking

src ​

ts
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

Inherited from ​

HTMLMediaElement.src

volume ​

ts
volume: number;

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

0 to 1

Inherited from ​

HTMLMediaElement.volume

Methods ​

addEventListener() ​

Call Signature ​

ts
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 ​
ParameterType
typeK
listener(this, event) => void
options?| boolean | AddEventListenerOptions
Returns ​

void

Inherited from ​

HTMLMediaElement.addEventListener

Call Signature ​

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

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

A boolean options (capture) is ignored

Parameters ​
ParameterType
typestring
listener| EventListenerOrEventListenerObject | null
options?| boolean | AddEventListenerOptions
Returns ​

void

Inherited from ​

HTMLMediaElement.addEventListener

canPlayType() ​

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

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

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

Parameters ​

ParameterType
typestring

Returns ​

"" | "maybe" | "probably"

Inherited from ​

HTMLMediaElement.canPlayType

dispatchEvent() ​

ts
dispatchEvent(event): boolean;

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

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

Parameters ​

ParameterType
eventEvent

Returns ​

boolean

Inherited from ​

HTMLMediaElement.dispatchEvent

fastSeek() ​

ts
fastSeek(time): void;

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

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

Parameters ​

ParameterType
timenumber

Returns ​

void

Inherited from ​

HTMLMediaElement.fastSeek

getAttribute() ​

ts
getAttribute(name): string | null;

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

Parameters ​

ParameterType
namestring

Returns ​

string | null

Inherited from ​

HTMLMediaElement.getAttribute

hasAttribute() ​

ts
hasAttribute(name): boolean;

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

Parameters ​

ParameterType
namestring

Returns ​

boolean

Inherited from ​

HTMLMediaElement.hasAttribute

load() ​

ts
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

Inherited from ​

HTMLMediaElement.load

pause() ​

ts
pause(): void;

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

Returns ​

void

Inherited from ​

HTMLMediaElement.pause

play() ​

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

Inherited from ​

HTMLMediaElement.play

removeAttribute() ​

ts
removeAttribute(name): void;

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

Parameters ​

ParameterType
namestring

Returns ​

void

Inherited from ​

HTMLMediaElement.removeAttribute

removeEventListener() ​

Call Signature ​

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

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

Type Parameters ​
Type Parameter
K extends keyof HTMLMediaElementEventMap
Parameters ​
ParameterType
typeK
listener(this, event) => void
Returns ​

void

Inherited from ​

HTMLMediaElement.removeEventListener

Call Signature ​

ts
removeEventListener(type, listener): void;

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

Parameters ​
ParameterType
typestring
listener| EventListenerOrEventListenerObject | null
Returns ​

void

Inherited from ​

HTMLMediaElement.removeEventListener

setAttribute() ​

ts
setAttribute(name, value): void;

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

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

Parameters ​

ParameterType
namestring
valuestring

Returns ​

void

Inherited from ​

HTMLMediaElement.setAttribute

The SDK is released under the Apache License 2.0

Copyright © 2026 DesktopEngine