AudioPlay
Defined in: packages/threeplay/src/plugins/audio/types.ts:30
A playing sound.
Methods
Section titled “Methods”stop()
Section titled “stop()”stop():
void
Defined in: packages/threeplay/src/plugins/audio/types.ts:38
Stops the sound for good (also resolves AudioPlay.ended).
Returns
Section titled “Returns”void
Properties
Section titled “Properties”
readonlyended:Promise<void>
Defined in: packages/threeplay/src/plugins/audio/types.ts:40
Resolves when the sound ends or is stopped (a loop only resolves when stopped).
paused
Section titled “paused”paused:
boolean
Defined in: packages/threeplay/src/plugins/audio/types.ts:32
Pauses and resumes the sound, keeping its position.
speed:
number
Defined in: packages/threeplay/src/plugins/audio/types.ts:36
Playback rate.
volume
Section titled “volume”volume:
number
Defined in: packages/threeplay/src/plugins/audio/types.ts:34
Gain 0–1.