SoundEventPlayback
Defined in: audio/SoundEventPlayback.ts:71
Per-App event ownership layered on Assets leases and Audio’s existing voice pool. Emitters of one canonical definition share admission across asset generations. Cooldown starts on admission, including later load/global-pool failures; stopping does not reset it.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SoundEventPlayback(
audio,resources,ownerAlive?,ownerPosition?):SoundEventPlayback
Defined in: audio/SoundEventPlayback.ts:89
Parameters
Section titled “Parameters”resources
Section titled “resources”() => Resources | null
ownerAlive?
Section titled “ownerAlive?”(owner) => boolean
ownerPosition?
Section titled “ownerPosition?”(owner) => Vec3 | null
Returns
Section titled “Returns”SoundEventPlayback
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: audio/SoundEventPlayback.ts:172
Returns
Section titled “Returns”void
getStats()
Section titled “getStats()”getStats():
SoundEventStats
Defined in: audio/SoundEventPlayback.ts:161
Returns
Section titled “Returns”load()
Section titled “load()”load(
ref,options?):Promise<SoundEventEmitter|null>
Defined in: audio/SoundEventPlayback.ts:100
Loading a definition is preparation, not a play intent; Audio.stopAll does not unload emitters.
alive is a pure lifetime predicate checked after asynchronous loads and on updates/triggers.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”alive?
Section titled “alive?”() => boolean
owner?
Section titled “owner?”number
number
Returns
Section titled “Returns”Promise<SoundEventEmitter | null>
stopAll()
Section titled “stopAll()”stopAll():
void
Defined in: audio/SoundEventPlayback.ts:156
Returns
Section titled “Returns”void
stopOwner()
Section titled “stopOwner()”stopOwner(
owner):void
Defined in: audio/SoundEventPlayback.ts:145
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
delta,listener?,right?):void
Defined in: audio/SoundEventPlayback.ts:133
Advance on simulation time; paused requests retain event and global voice ownership.
Parameters
Section titled “Parameters”number
listener?
Section titled “listener?”right?
Section titled “right?”Returns
Section titled “Returns”void