SoundEventHandle
Defined in: audio/SoundEventPlayback.ts:20
A trigger’s controls remain valid while its selected clip loads.
Extends
Section titled “Extends”Properties
Section titled “Properties”currentTime
Section titled “currentTime”
readonlycurrentTime:number
Defined in: audio/PlatformAudioBackend.ts:16
Inherited from
Section titled “Inherited from”duration
Section titled “duration”
readonlyduration:number
Defined in: audio/PlatformAudioBackend.ts:17
Inherited from
Section titled “Inherited from”
readonlyerror:string|null
Defined in: audio/SoundEventPlayback.ts:23
readonlyid:number
Defined in: audio/PlatformAudioBackend.ts:7
Inherited from
Section titled “Inherited from”isPlaying
Section titled “isPlaying”
readonlyisPlaying:boolean
Defined in: audio/PlatformAudioBackend.ts:15
Inherited from
Section titled “Inherited from”onEnd?
Section titled “onEnd?”
optionalonEnd?: () =>void
Defined in: audio/PlatformAudioBackend.ts:18
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”
readonlyready:Promise<SoundEventStatus>
Defined in: audio/SoundEventPlayback.ts:26
Initial loading resolves to its resulting status, including early cancellation.
reason
Section titled “reason”
readonlyreason:SoundEventRejection|null
Defined in: audio/SoundEventPlayback.ts:22
selection
Section titled “selection”
readonlyselection:Readonly<SoundEventSelection> |null
Defined in: audio/SoundEventPlayback.ts:24
status
Section titled “status”
readonlystatus:SoundEventStatus
Defined in: audio/SoundEventPlayback.ts:21
Methods
Section titled “Methods”pause()
Section titled “pause()”pause():
void
Defined in: audio/PlatformAudioBackend.ts:9
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”resume()
Section titled “resume()”resume():
void
Defined in: audio/PlatformAudioBackend.ts:10
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setLoop()
Section titled “setLoop()”setLoop(
loop):void
Defined in: audio/PlatformAudioBackend.ts:13
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setPan()
Section titled “setPan()”setPan(
pan):void
Defined in: audio/PlatformAudioBackend.ts:12
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setPlaybackRate()
Section titled “setPlaybackRate()”setPlaybackRate(
rate):void
Defined in: audio/PlatformAudioBackend.ts:14
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setVolume()
Section titled “setVolume()”setVolume(
volume):void
Defined in: audio/PlatformAudioBackend.ts:11
Parameters
Section titled “Parameters”volume
Section titled “volume”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”stop()
Section titled “stop()”stop():
void
Defined in: audio/PlatformAudioBackend.ts:8
Returns
Section titled “Returns”void