AudioEngine | @jiggy/assets

public constructor AudioEngine

Creates an AudioEngine to manage and play different
audio assets.

This class is abstract and must be subclassed, with
an implementation to the abstract methods.

TODO: Make a way to mute/unmute All Audio

Hierarchy

EventEmitter
- AudioEngine
  - HTML5AudioEngine

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AudioEngine(): AudioEngine

- Defined in audio/AudioEngine.ts:32
Returns AudioEngine

Properties

Private _audioMap

_audioMap: AudioMap

Private _logManager

_logManager: LogManager

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Protected _attachEndEvent

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

- Defined in audio/AudioEngine.ts:403
protected _attachEndEvent
```
Attaches the end event on an asset.
```
Parameters
- asset: Asset
- name: string
- audio: Asset
Returns void

Protected _attachStartEvent

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

- Defined in audio/AudioEngine.ts:388
protected _attachStartEvent
```
Attaches the start event on an asset.
```
Parameters
- asset: Asset
- name: string
- audio: Asset
Returns void

Protected _getAudio

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

- Defined in audio/AudioEngine.ts:342
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

- Defined in audio/AudioEngine.ts:514
protected abstract _getAudioDuration
```
The logic to get the total duration of an audio asset.
Must be implemented by subclasses.
```
Parameters
- audio: Asset
Returns number

Protected _getData

_getData(audio: Asset): Object

- Defined in audio/AudioEngine.ts:376
protected _getData
```
Gets the asset's data.
```
Parameters
- audio: Asset
Returns Object

Protected _getTimeCursor

_getTimeCursor(audio: Asset): number

protected abstract _getTimeCursor

The logic to get the current time playing of an audio asset,
in seconds.
Must be implemented by subclasses.

Parameters

audio: Asset

Returns number

Protected _getVolume

_getVolume(audio: Asset): number

- Defined in audio/AudioEngine.ts:558
protected abstract _getVolume
```
The logic to get the volume of an audio asset.
```
Parameters
- audio: Asset
Returns number

Protected _isAudioLooping

_isAudioLooping(audio: Asset): boolean

protected abstract _isAudioLooping

The logic to check for audio looping.
Return true, if audio is looping.
Must be implemented by subclasses.

Parameters

audio: Asset

Returns boolean

Protected _isAudioMuted

_isAudioMuted(audio: Asset): boolean

protected abstract _isAudioMuted

The logic to check for muted audio.
Returns true if audio is muted.
Must be implemented by subclasses.

Parameters

audio: Asset

Returns boolean

Protected _loopAudio

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

- Defined in audio/AudioEngine.ts:479
protected abstract _loopAudio
```
The logic to enable audio looping.
Must be implemented by subclasses.
```
Parameters
- audio: Asset
- state: boolean
Returns void

Protected _muteAudio

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

- Defined in audio/AudioEngine.ts:503
protected abstract _muteAudio
```
The logic to mute audio.
Must be implemented by subclasses.
```
Parameters
- audio: Asset
- state: boolean
Returns void

Protected _pauseAudio

_pauseAudio(audio: Asset): void

- Defined in audio/AudioEngine.ts:445
protected abstract _pauseAudio
```
The logic to pause audio. Must be implemented by subclasses.
```
Parameters
- audio: Asset
Returns void

Protected _playAudio

_playAudio(audio: Asset): void

- Defined in audio/AudioEngine.ts:435
protected abstract _playAudio
```
The logic to play audio. Must be implemented by subclasses.
```
Parameters
- audio: Asset
Returns void

Protected _registerEndEvent

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

- Defined in audio/AudioEngine.ts:586
protected abstract _registerEndEvent
```
The logic for registering a callback mechanism for when audio
stops playing. This callback should reset the playing attribute
on the asset to false.
```
Name & audio fields are for event reporting.
Parameters
- asset: Asset
- name: string
- audio: Asset
Returns void

Protected _registerEvents

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

- Defined in audio/AudioEngine.ts:418
protected _registerEvents
```
Attaches all mandatory events on each channel.
```
Parameters
- channelArray: Asset[]
- name: string
- audio: Asset
Returns void

Protected _registerStartEvent

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

- Defined in audio/AudioEngine.ts:572
protected abstract _registerStartEvent
```
The logic for registering a callback mechanism for when audio
begins playing. This callback should set tehe playing attribute
on the asset to true.
```
Name & audio fields are for event reporting.
Parameters
- asset: Asset
- name: string
- audio: Asset
Returns void

Protected _setAudio

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

- Defined in audio/AudioEngine.ts:303
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

- Defined in audio/AudioEngine.ts:525
protected abstract _setTimeCursor
```
The logic to set the current time played of an audio asset.
Must be implemented by subclasses.
```
Parameters
- audio: Asset
- seconds: number
Returns void

Protected _setVolume

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

- Defined in audio/AudioEngine.ts:548
protected abstract _setVolume
```
The logic to set the volume of an audio asset.
Must be implemented by subclasses.
```
Parameters
- audio: Asset
- volume: number
Returns void

Protected _stopAudio

_stopAudio(audio: Asset): void

- Defined in audio/AudioEngine.ts:455
protected abstract _stopAudio
```
The logic to stop audio. Must be implemented by subclasses.
```
Parameters
- audio: Asset
Returns void

Protected _warnMissingAudio

_warnMissingAudio(name: string): void

- Defined in audio/AudioEngine.ts:329
protected _warnMissingAudio
```
Reports an audio missing warning.
```
Parameters
- name: string
  
  User friendly reference.
Returns void

addAudio

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

- Defined in audio/AudioEngine.ts:49
public addAudio
```
Adds an audio asset to this audio engine.
```
Parameters
- name: string
  
  User Friendly name
- audio: Asset
- Optional channels: number
  
  Optional
Returns void

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:814
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:824
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:825
Returns Array<string | symbol>

getAudioDuration

getAudioDuration(name: string): number

- Defined in audio/AudioEngine.ts:220
public getAudioDuration
```
Gets the duration of the audio asset (in seconds).
```
Parameters
- name: string
  
  User friendly name
Returns number

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:822
Returns number

getTimeCursor

getTimeCursor(name: string): number

- Defined in audio/AudioEngine.ts:253
public getTimeCursor
```
Gets the current time being played on the audio asset,
in seconds.
```
Parameters
- name: string
  
  User friendly name
Returns number

getVolume

getVolume(name: string): number

- Defined in audio/AudioEngine.ts:284
public getVolume
```
Gets the volume of the audio asset.
```
Parameters
- name: string
  
  User friendly name
Returns number

hasAudio

hasAudio(name: string): boolean

- Defined in audio/AudioEngine.ts:64
public hasAudio
```
Returns true, if an audio asset by name exists.
```
Parameters
- name: string
  
  User friendly name.
Returns boolean

isAudioLooping

isAudioLooping(name: string): boolean

- Defined in audio/AudioEngine.ts:156
public isAudioLooping
```
Returns true, if audio asset will loop.
```
Parameters
- name: string
  
  User friendly name
Returns boolean

isAudioMuted

isAudioMuted(name: string): boolean

- Defined in audio/AudioEngine.ts:188
public isAudioMuted
```
Returns true if the audio asset is muted.
```
Parameters
- name: string
  
  User friendly name
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:826
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:823
Parameters
- event: string | symbol
Returns Function[]

loopAudio

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

- Defined in audio/AudioEngine.ts:173
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

- Defined in audio/AudioEngine.ts:205
public muteAudio
```
Mutes an audio asset.
```
Parameters
- name: string
- state: boolean
Returns void

on

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

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:815
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:816
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pauseAudio

pauseAudio(name: string): void

- Defined in audio/AudioEngine.ts:124
public pauseAudio
```
Pauses an audio asset.
```
Parameters
- name: string
  
  User friendly name
Returns void

playAudio

playAudio(name: string): void

- Defined in audio/AudioEngine.ts:108
public playAudio
```
Plays an audio asset.
```
Parameters
- name: string
  
  User friendly name
Returns void

prependListener

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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:817
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:818
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

releaseAssets

releaseAssets(): void

- Defined in audio/AudioEngine.ts:93
public releaseAssets
```
Removes all audio assets from the audio engine.
```
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:820
Parameters
- Optional event: string | symbol
Returns this

removeAudio

removeAudio(name: string): void

- Defined in audio/AudioEngine.ts:78
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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:819
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:821
Parameters
- n: number
Returns this

setTimeCursor

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

- Defined in audio/AudioEngine.ts:237
public setTimeCursor
```
Sets the current time to be played on the audio asset,
in seconds.
```
Parameters
- name: string
  
  User friendly name
- seconds: number
Returns void

setVolume

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

- Defined in audio/AudioEngine.ts:269
public setVolume
```
Sets the volume of the audio asset.
```
Parameters
- name: string
  
  User friendly name
- volume: number
Returns void

stopAudio

stopAudio(name: string): void

- Defined in audio/AudioEngine.ts:140
public stopAudio
```
Stops an audio asset. (Resets time cursor back to 0 seconds).
```
Parameters
- name: string
  
  User friendly name
Returns void

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /mnt/c/Users/norman/development/Jiggy.io/node_modules/@types/node/index.d.ts:811
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AudioEngine

Properties

Private _audioMap

Private _logManager

Static defaultMaxListeners

Methods

Protected _attachEndEvent

Parameters

asset: Asset

name: string

audio: Asset

Returns void

Protected _attachStartEvent

Parameters

asset: Asset

name: string

audio: Asset

Returns void

Protected _getAudio

Parameters

name: string

Optional justGiveChannel1: boolean

Returns Asset

Protected _getAudioDuration

Parameters

audio: Asset

Returns number

Protected _getData

Parameters

audio: Asset

Returns Object

Protected _getTimeCursor

Parameters

audio: Asset

Returns number

Protected _getVolume

Parameters

audio: Asset

Returns number

Protected _isAudioLooping

Parameters

audio: Asset

Returns boolean

Protected _isAudioMuted

Parameters

audio: Asset

Returns boolean

Protected _loopAudio

Parameters

audio: Asset

state: boolean

Returns void

Protected _muteAudio

Parameters

audio: Asset

state: boolean

Returns void

Protected _pauseAudio

Parameters

audio: Asset

Returns void

Protected _playAudio

Parameters

audio: Asset

Returns void

Protected _registerEndEvent

Parameters

asset: Asset

name: string

audio: Asset

Returns void

Protected _registerEvents

Parameters