EZ Web Audio

Appearance

EZ Web Audio / Playable

Interface: Playable ​

Defined in: packages/core/src/interfaces/playable.ts:12

Minimal contract for playable audio sources.

This interface defines the core playback lifecycle methods shared by all audio classes. Convenience methods like fadeIn(), fadeOut(), and dispose() are available on BaseSound but are not part of this minimal contract, as they depend on implementation details (gain ramping, node disconnection).

Properties ​

dispose()? ​

optional dispose: () => void

Defined in: packages/core/src/interfaces/playable.ts:44

Release all audio resources. Optional — available on BaseSound.

Returns ​

void

duration ​

duration: TimeObject

Defined in: packages/core/src/interfaces/playable.ts:22

fadeIn()? ​

optional fadeIn: (duration) => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:40

Fade in over the given duration (seconds). Optional — available on BaseSound.

Parameters ​

duration ​

number

Returns ​

Promise<void>

fadeOut()? ​

optional fadeOut: (duration) => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:42

Fade out over the given duration (seconds) and stop. Optional — available on BaseSound.

Parameters ​

duration ​

number

Returns ​

Promise<void>

isPlaying ​

isPlaying: boolean

Defined in: packages/core/src/interfaces/playable.ts:21

onPlayRamp() ​

onPlayRamp: (type, rampType?) => object

Defined in: packages/core/src/interfaces/playable.ts:31

Parameters ​

type ​

SoundControlType

rampType? ​

RampType

Returns ​

object

from() ​

from: (startValue) => object

Parameters ​
startValue ​

number

Returns ​

object

to() ​

to: (endValue) => object

Parameters ​
endValue ​

number

Returns ​

object

in() ​

in: (endTime) => void

Parameters ​
endTime ​

number

Returns ​

void

onPlaySet() ​

onPlaySet: (type) => object

Defined in: packages/core/src/interfaces/playable.ts:24

Parameters ​

type ​

SoundControlType

Returns ​

object

to() ​

to: (value) => object

Parameters ​
value ​

number

Returns ​

object

at() ​

at: (time) => void

Parameters ​
time ​

number

Returns ​

void

endingAt() ​

endingAt: (time, rampType?) => void

Parameters ​
time ​

number

rampType? ​

RampType

Returns ​

void

play() ​

play: () => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:13

Returns ​

Promise<void>

playAt() ​

playAt: (time) => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:14

Parameters ​

time ​

number

Returns ​

Promise<void>

playFor() ​

playFor: (duration) => void

Defined in: packages/core/src/interfaces/playable.ts:16

Parameters ​

duration ​

number

Returns ​

void

playIn() ​

playIn: (when) => void

Defined in: packages/core/src/interfaces/playable.ts:15

Parameters ​

when ​

number

Returns ​

void

playInAndStopAfter() ​

playInAndStopAfter: (playIn, stopAfter) => void

Defined in: packages/core/src/interfaces/playable.ts:17

Parameters ​

playIn ​

number

stopAfter ​

number

Returns ​

void

stop() ​

stop: () => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:18

Returns ​

Promise<void>

stopAt() ​

stopAt: (time) => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:20

Parameters ​

time ​

number

Returns ​

Promise<void>

stopIn() ​

stopIn: (seconds) => Promise<void>

Defined in: packages/core/src/interfaces/playable.ts:19

Parameters ​

seconds ​

number

Returns ​

Promise<void>