Skip to content
YAGE Logo YAGE

AudioPlayOptions

Defined in: audio/src/types.ts:29

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

channel?

Section titled “channel?”

optional channel?: string

Defined in: audio/src/types.ts:30

loop?

Section titled “loop?”

optional loop?: boolean

Defined in: audio/src/types.ts:32

onEnd?

Section titled “onEnd?”

optional onEnd?: () => void

Defined in: audio/src/types.ts:40

Called once when the sound finishes on its own (its end event). NOT called when you stop() it, and never for a looping sound (it has no end). The “tell me when this clip is done” seam — e.g. gating dialogue auto-advance on a voice clip.

Returns

Section titled “Returns”

void

speed?

Section titled “speed?”

optional speed?: number

Defined in: audio/src/types.ts:33

volume?

Section titled “volume?”

optional volume?: number

Defined in: audio/src/types.ts:31

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/audio.md.