InterfaceAudio System@public

FlxAudioService

Audio service interface consumed by FlxG and FlxGame.

export interface FlxAudioService

Properties

Property	Modifiers	Type	Description
music	-	FlxSound | null	-
musicGroup	readonly	FlxSoundGroup	-
mute	-	boolean	-
soundGroup	readonly	FlxSoundGroup	-
sounds	readonly	FlxGroup	-
volume	-	number	-

Methods

destroy()

destroy(): void

Returns: void

destroySounds()

destroySounds(forceDestroy: boolean): void

Parameters:

Parameter	Type	Description
forceDestroy	boolean	-

Returns: void

onChange()

onChange?(listener: (state: FlxAudioState) => void): () => void

Subscribe to master volume/mute changes when supported.

Parameters:

Parameter	Type	Description
listener	(state: FlxAudioState) => void	-

Returns: () => void

pauseSounds()

pauseSounds(): void

Returns: void

play()

play(source: unknown, volume?: number, loop?: boolean, autoDestroy?: boolean, group?: FlxSoundGroup): FlxSound

Parameters:

Parameter	Type	Description
source	unknown	-
volume	number	-
loop	boolean	-
autoDestroy	boolean	-
group	FlxSoundGroup	-

Returns: FlxSound

playMusic()

playMusic(source: unknown, volume?: number, group?: FlxSoundGroup): void

Parameters:

Parameter	Type	Description
source	unknown	-
volume	number	-
group	FlxSoundGroup	-

Returns: void

resumeSounds()

resumeSounds(): void

Returns: void

stream()

stream(url: string, volume?: number, loop?: boolean, autoDestroy?: boolean, group?: FlxSoundGroup): FlxSound

Parameters:

Parameter	Type	Description
url	string	-
volume	number	-
loop	boolean	-
autoDestroy	boolean	-
group	FlxSoundGroup	-

Returns: FlxSound

updateSounds()

updateSounds(elapsed: number): void

Parameters:

Parameter	Type	Description
elapsed	number	-

Returns: void