Interface: SoundUnsavedInterface

Defined in: src/sound/interfaces/SoundUnsavedInterface.ts:3

Methods

pauseAll()

> pauseAll(channel?): this

Defined in: src/sound/interfaces/SoundUnsavedInterface.ts:21

Temporarily pause all currently-playing sounds (or just those in the given channel) without persisting the paused state. Useful for overlays / pause menus.

Only sounds that are actively playing at the time of the call are paused; sounds that were already paused beforehand are left untouched so that they remain paused when resumeAll is called later.

When called without a channel argument all transient players started with playTransient are also stopped.

Parameters

channel?

string

Returns

this

---

playTransient()

> playTransient(alias, options?): Promise<Player>

Defined in: src/sound/interfaces/SoundUnsavedInterface.ts:8

Plays a non-persistent ("transient") sound (e.g. UI / menu sounds). Transient playback is not tracked in save/export state.

Parameters

alias

string

options?

Partial<PlayerOptions>

Returns

Promise<Player>

---

resumeAll()

> resumeAll(channel?): this

Defined in: src/sound/interfaces/SoundUnsavedInterface.ts:27

Resume all sounds (or just those in the given channel) that were paused by the most recent call to pauseAll. Sounds that were already paused before pauseAll was called are not resumed.

Parameters

channel?

string

Returns

this

---

stopTransientAll()

> stopTransientAll(): this

Defined in: src/sound/interfaces/SoundUnsavedInterface.ts:31

Stop all transient media instances started with playTransient.

Returns

this