Class SoundtrackDirector

Index

Methods

create defineState hasState stateIds setState getCurrentState pickTrack playStinger cancelStinger getSnapshot tick clear dispose

Methods

`Static`create

create(opts?: SoundtrackDirectorOptions): SoundtrackDirector
Parameters
- opts: SoundtrackDirectorOptions = {}
Returns SoundtrackDirector
- Defined in runtime/soundtrack-director.ts:167

defineState

defineState(spec: MusicStateSpec): boolean
Parameters
- spec: MusicStateSpec
Returns boolean
- Defined in runtime/soundtrack-director.ts:173

hasState

hasState(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/soundtrack-director.ts:193

stateIds

stateIds(): string[]
Returns string[]
- Defined in runtime/soundtrack-director.ts:197

setState

setState(stateId: string, opts?: SetStateOptions): boolean
Parameters
- stateId: string
- opts: SetStateOptions = {}
Returns boolean
- Defined in runtime/soundtrack-director.ts:210

getCurrentState

getCurrentState(): string | null
Returns string | null
- Defined in runtime/soundtrack-director.ts:250

pickTrack

pickTrack(stateId?: string): string | null
Parameters
- OptionalstateId: string
Returns string | null
- Defined in runtime/soundtrack-director.ts:256

playStinger

playStinger(spec: StingerSpec): boolean
Parameters
- spec: StingerSpec
Returns boolean
- Defined in runtime/soundtrack-director.ts:266

cancelStinger

cancelStinger(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/soundtrack-director.ts:282

getSnapshot

getSnapshot(): SoundtrackSnapshot
Returns SoundtrackSnapshot
- Defined in runtime/soundtrack-director.ts:291

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/soundtrack-director.ts:310

clear

clear(): void
Returns void
- Defined in runtime/soundtrack-director.ts:339

dispose

dispose(): void
Returns void
- Defined in runtime/soundtrack-director.ts:352