AudioPlayOptions
Defined in: audio/src/types.ts:16
Properties
Section titled “Properties”channel?
Section titled “channel?”
optionalchannel?:string
Defined in: audio/src/types.ts:17
optionalloop?:boolean
Defined in: audio/src/types.ts:19
onEnd?
Section titled “onEnd?”
optionalonEnd?: () =>void
Defined in: audio/src/types.ts:27
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?”
optionalspeed?:number
Defined in: audio/src/types.ts:20
volume?
Section titled “volume?”
optionalvolume?:number
Defined in: audio/src/types.ts:18