Class CueCatalog

Index

Methods

create register unregister has list play stopAll

Methods

`Static`create

create(
    audioBus: AudioBus,
    spatialBus: SpatialAudioBus,
    cache: AudioAssetCache,
    options?: CueCatalogOptions,
): CueCatalog
Parameters
- audioBus: AudioBus
- spatialBus: SpatialAudioBus
- cache: AudioAssetCache
- Optionaloptions: CueCatalogOptions
Returns CueCatalog
- Defined in audio/cue-catalog.ts:107

register

register(name: string, def: CueDefinition): void
Parameters
- name: string
- def: CueDefinition
Returns void
- Defined in audio/cue-catalog.ts:117

unregister

unregister(name: string): void
Parameters
- name: string
Returns void
- Defined in audio/cue-catalog.ts:124

has

has(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in audio/cue-catalog.ts:133

list

list(): readonly string[]
Returns readonly string[]
- Defined in audio/cue-catalog.ts:137

play

play(name: string, options?: CuePlayOptions): SpatialSourceHandle | null
Parameters
- name: string
- Optionaloptions: CuePlayOptions
Returns SpatialSourceHandle | null
- Defined in audio/cue-catalog.ts:145

stopAll

stopAll(name: string): void
Parameters
- name: string
Returns void
- Defined in audio/cue-catalog.ts:236