Options
All
  • Public
  • Public/Protected
  • All
Menu

The AudioManager manages loading audio and audio playback

Hierarchy

  • AudioManager

Index

Accessors

isBackgroundAudioMuted

  • get isBackgroundAudioMuted(): boolean
  • Returns boolean

Static instance

Methods

addAudioFromGlobalLibrary

  • addAudioFromGlobalLibrary(library: GlobalAudioLibrary, names: string | Array<string>, onComplete?: Function): void
  • Parameters

    • library: GlobalAudioLibrary
    • names: string | Array<string>
    • Default value onComplete: Function = null

    Returns void

addBackgroundAudio

  • addBackgroundAudio(resources: Array<AudioLoaderInfo>, onLoadCompleted?: Function): void
  • Parameters

    • resources: Array<AudioLoaderInfo>
    • Default value onLoadCompleted: Function = undefined

    Returns void

addForegroundAudio

  • Parameters

    Returns void

addGlobalAudio

  • Parameters

    Returns void

exists

  • exists(name: string, sprite?: string): boolean
  • Returns true/false if an audio has been added and loaded successfully

    Parameters

    • name: string

      Name of the audio group (single audio or audio of sprites)

    • Optional sprite: string

      Name of the sprite (optional)

    Returns boolean

findAll

  • findAll(nameOrSprite: string): Array<{ name: string; sprite: string }>
  • Return all audio that matches nameOrSprite. Matches single audio names and sprites. Only searches audio that has been added to audio manager and loaded successfully

    Parameters

    • nameOrSprite: string

      Name/group or sprite to search for

    Returns Array<{ name: string; sprite: string }>

isAudioDecoded

  • isAudioDecoded(): boolean
  • Returns boolean

isPlaying

  • isPlaying(name: string, sprite?: string): boolean
  • Check if an audio is paying

    Parameters

    • name: string

      Name of the audio group (single audio or audio of sprites)

    • Default value sprite: string = null

      Name of the sprite (optional)

    Returns boolean

muteBackgroundAudio

  • muteBackgroundAudio(mute: boolean): void
  • Parameters

    • mute: boolean

    Returns void

onGameStateChanged

  • onGameStateChanged(): void
  • Returns void

pauseAllForeground

  • pauseAllForeground(): void
  • Returns void

play

  • Play a loaded audio

    Parameters

    • playInfo: string | IAudioPlayInfo
    • Optional sprite: string

      Name of the sprite (optional)

    Returns AudioClip

    AudioClip object where playback properties can be changed and callback functions set

playBackground

  • playBackground(name?: string): void
  • Play a loaded background audio

    Parameters

    • Optional name: string

      Name of the background audio (optional). If not set, the first background audio found will be used

    Returns void

playFromGlobal

  • Play audio sprite from "globalAudio". If the sprite is not found, try to play single audio.

    Parameters

    • sprite: string

      Name of the sprite in "globalAudio". If not found try playing single audio named by 'sprite'

    Returns AudioClip

    AudioClip object where playback properties can be changed and callback functions set

playSequence

resumeAllForeground

  • resumeAllForeground(): void
  • Returns void

setBackgroundVolume

  • setBackgroundVolume(volume: number): void
  • Parameters

    • volume: number

    Returns void

stop

  • stop(name: string, sprite?: string): void
  • Parameters

    • name: string
    • Default value sprite: string = null

    Returns void

stopAll

  • stopAll(): void
  • Returns void

stopAllForeground

  • stopAllForeground(): void
  • Returns void

stopBackground

  • stopBackground(): void
  • Returns void

unload

  • unload(names: string | Array<string>): void
  • Parameters

    • names: string | Array<string>

    Returns void