Class SoundPlayer

Implements

ISoundPlayer

Index

Constructors

Methods

createInstance enqueuePlay freeInstance playNow setInstanceMask update

Constructors

constructor

new SoundPlayer(sounds: Sounds): SoundPlayer
Parameters
- sounds: Sounds
Returns SoundPlayer
- Defined in src/ts/frontend/audio/soundPlayer.ts:68

Methods

createInstance

createInstance(
    soundType: SoundType,
    mask: number,
    initialTargetVolume: number,
    isPonctual: boolean,
): ISoundInstance
Parameters
- soundType: SoundType
- mask: number
- initialTargetVolume: number
- isPonctual: boolean
Returns ISoundInstance
Implementation of ISoundPlayer.createInstance
- Defined in src/ts/frontend/audio/soundPlayer.ts:116

enqueuePlay

enqueuePlay(soundType: SoundType): void
Parameters
- soundType: SoundType
Returns void
Implementation of ISoundPlayer.enqueuePlay
- Defined in src/ts/frontend/audio/soundPlayer.ts:112

freeInstance

freeInstance(instance: ISoundInstance): void
Parameters
- instance: ISoundInstance
Returns void
Implementation of ISoundPlayer.freeInstance
- Defined in src/ts/frontend/audio/soundPlayer.ts:129

playNow

playNow(soundType: SoundType): void
Parameters
- soundType: SoundType
Returns void
Implementation of ISoundPlayer.playNow
- Defined in src/ts/frontend/audio/soundPlayer.ts:108

setInstanceMask

setInstanceMask(mask: number): void
Parameters
- mask: number
Returns void
Implementation of ISoundPlayer.setInstanceMask
- Defined in src/ts/frontend/audio/soundPlayer.ts:134

update

update(): void
Returns void
Implementation of ISoundPlayer.update
- Defined in src/ts/frontend/audio/soundPlayer.ts:138