Audio

The Audio class provides audio playback functionality similar to the HTMLAudioElement in web browsers.

Supported Audio Formats

mp3 — MP3 audio using dr_mp3
wav — WAV audio using dr_wav
ogg — OGG Vorbis audio using stb_vorbis

Example

const audio = new Audio('romfs:/music.mp3');
audio.addEventListener('canplaythrough', () => {
  audio.play();
});

Parameter	Type
`src`?	`string`

Properties

Property	Type
`oncanplaythrough`	`null` \| (`this`, `ev`) => `any`
`onended`	`null` \| (`this`, `ev`) => `any`
`onerror`	`null` \| (`this`, `ev`) => `any`
`onloadedmetadata`	`null` \| (`this`, `ev`) => `any`
`onpause`	`null` \| (`this`, `ev`) => `any`
`onplay`	`null` \| (`this`, `ev`) => `any`
`ontimeupdate`	`null` \| (`this`, `ev`) => `any`

Accessors

currentSrc

get currentSrc(): string

Parameter	Type
`val`	`number`

Parameter	Type
`val`	`boolean`

Parameter	Type
`val`	`number`

readyState

get readyState(): number

Parameter	Type
`val`	`string`

Parameter	Type
`val`	`number`

HAVE_CURRENT_DATA

get static HAVE_CURRENT_DATA(): number

HAVE_ENOUGH_DATA

get static HAVE_ENOUGH_DATA(): number

HAVE_FUTURE_DATA

get static HAVE_FUTURE_DATA(): number

HAVE_METADATA

get static HAVE_METADATA(): number

HAVE_NOTHING

get static HAVE_NOTHING(): number

Methods

addEventListener()

addEventListener(type, callback, options?): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

Parameters

Parameter	Type
`type`	`string`
`callback`	`null` \| `EventListenerOrEventListenerObject`<`any`>
`options`?	`boolean` \| `AddEventListenerOptions`

Parameter	Type
`event`	`Event`

Parameter	Type
`type`	`string`
`callback`	`null` \| `EventListenerOrEventListenerObject`<`any`>
`options`?	`boolean` \| `EventListenerOptions`

Audio

On this page