Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTML5AudioEngine

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _backgroundAudios

_backgroundAudios: Asset[]

Private _backgroundVolume

_backgroundVolume: number

Private _soundEffectVolume

_soundEffectVolume: number

Private _soundEffects

_soundEffects: Asset[]

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Protected _attachEndEvent

  • _attachEndEvent(asset: Asset, name: string, audio: Asset): void

Protected _attachStartEvent

  • _attachStartEvent(asset: Asset, name: string, audio: Asset): void

Protected _getAudio

  • _getAudio(name: string, justGiveChannel1?: boolean): Asset

  • protected _getAudio

    Gets an audio asset from the audio hash map.

    Parameters

    • name: string

      User friendly reference

    • Optional justGiveChannel1: boolean

      If true, does NOT search for an available channel

    Returns Asset

Protected _getAudioDuration

  • _getAudioDuration(audio: Asset): number

Protected _getData

  • _getData(audio: Asset): Object

Protected _getTimeCursor

  • _getTimeCursor(audio: Asset): number

Protected _getVolume

  • _getVolume(audio: Asset): number

Protected _isAudioLooping

  • _isAudioLooping(audio: Asset): boolean

Protected _isAudioMuted

  • _isAudioMuted(audio: Asset): boolean

Protected _loopAudio

  • _loopAudio(audio: Asset, state: boolean): void

Protected _muteAudio

  • _muteAudio(audio: Asset, state: boolean): void

Protected _pauseAudio

  • _pauseAudio(audio: Asset): void

Protected _playAudio

  • _playAudio(audio: Asset): void

Protected _registerEndEvent

  • _registerEndEvent(asset: Asset, name: string, audio: Asset): void

Protected _registerEvents

  • _registerEvents(channelArray: Asset[], name: string, audio: Asset): void

Protected _registerStartEvent

  • _registerStartEvent(asset: Asset, name: string, audio: Asset): void

Protected _setAudio

  • _setAudio(name: string, audio: Asset, channels: number): void

  • protected _setAudio

    Adds an audio asset to the audio hash map.
If audio is null, then the key is deleted.

    Parameters

    • name: string

      User friendly reference

    • audio: Asset
    • channels: number

    Returns void

Protected _setTimeCursor

  • _setTimeCursor(audio: Asset, seconds: number): void

Protected _setVolume

  • _setVolume(audio: Asset, volume: number): void

Protected _stopAudio

  • _stopAudio(audio: Asset): void

Private _updateVolume

  • _updateVolume(audio: Asset): void

Protected _warnMissingAudio

  • _warnMissingAudio(name: string): void

addAudio

  • addAudio(name: string, audio: Asset, channels?: number): void

addBackgroundMusic

  • addBackgroundMusic(name: string, audio: Asset): void

addListener

  • addListener(event: string | symbol, listener: function): this

addSoundEffect

  • addSoundEffect(name: string, audio: Asset): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

eventNames

  • eventNames(): Array<string | symbol>

getAudioDuration

  • getAudioDuration(name: string): number

getMaxListeners

  • getMaxListeners(): number

getTimeCursor

  • getTimeCursor(name: string): number

getVolume

  • getVolume(name: string): number

hasAudio

  • hasAudio(name: string): boolean

isAudioLooping

  • isAudioLooping(name: string): boolean

isAudioMuted

  • isAudioMuted(name: string): boolean

isBackgroundMusic

  • isBackgroundMusic(audio: Asset): boolean

isSoundEffect

  • isSoundEffect(audio: Asset): boolean

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

loopAudio

  • loopAudio(name: string, state: boolean): void

  • public loopAudio

    Enables looping of an audio asset.

    Parameters

    • name: string

      User friendly name

    • state: boolean

      Should the audio asset loop?

    Returns void

muteAudio

  • muteAudio(name: string, state: boolean): void

on

  • on(event: string | symbol, listener: function): this

once

  • once(event: string | symbol, listener: function): this

pauseAudio

  • pauseAudio(name: string): void

playAudio

  • playAudio(name: string): void

prependListener

  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

releaseAssets

  • releaseAssets(): void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeAudio

  • removeAudio(name: string): void

  • public removeAudio

    Removes an audio asset from this audio engine.
Will stop the audio if playing.

    Parameters

    • name: string

      User friendly name

    Returns void

removeListener

  • removeListener(event: string | symbol, listener: function): this

setBackgroundVolume

  • setBackgroundVolume(volume: number): void

setMaxListeners

  • setMaxListeners(n: number): this

setSoundEffectVolume

  • setSoundEffectVolume(volume: number): void

setTimeCursor

  • setTimeCursor(name: string, seconds: number): void

setVolume

  • setVolume(name: string, volume: number): void

stopAudio

  • stopAudio(name: string): void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

Generated using TypeDoc