Skip to content
InterfaceAudio System@public

FlxSoundHandle

Low-level handle to a single playing sound, owned by a backend. FlxSound drives playback through this interface.

ts
export interface FlxSoundHandle

Properties

PropertyModifiersTypeDescription
durationreadonlynumber-
playingreadonlyboolean-
positionreadonlynumber-

Methods

destroy()

ts
destroy(): void

Returns: void

pause()

ts
pause(): void

Returns: void

play()

ts
play(startTime?: number, loop?: boolean): void

Parameters:

ParameterTypeDescription
startTimenumber-
loopboolean-

Returns: void

resume()

ts
resume(): void

Returns: void

setPan()

ts
setPan(pan: number): void

Parameters:

ParameterTypeDescription
pannumber-

Returns: void

setVolume()

ts
setVolume(volume: number): void

Parameters:

ParameterTypeDescription
volumenumber-

Returns: void

stop()

ts
stop(): void

Returns: void

Released under the MIT License.