API Docs for: 1.4.0
Show:

Kiwi.Sound.AudioLibrary Class

Defined in: src\sound\AudioLibrary.ts:10
Module: Sound
Parent Module: Kiwi

Holds a reference to all of the Audio Files (mp3, ogg, e.t.c) that are accessible on the State that this AudioLibrary is on.

Constructor

Kiwi.Sound.AudioLibrary

(
  • game
)
Kiwi.Sound.AudioLibrary

Defined in src\sound\AudioLibrary.ts:10

Parameters:

  • game Kiwi.Game

    The game that this audio library is a member of.

Returns:

Kiwi.Sound.AudioLibrary:

Item Index

Methods

Properties

Methods

add

(
  • audioFile
)
public

Defined in src\sound\AudioLibrary.ts:86

Adds a new audio file to the audio library.

Parameters:

clear

() public

Defined in src\sound\AudioLibrary.ts:53

Resets the audio library.

objType

() String public

Defined in src\sound\AudioLibrary.ts:27

The type of object that this is.

Returns:

String:

"AudioLibrary"

rebuild

(
  • fileStore
  • state
)
public

Defined in src\sound\AudioLibrary.ts:65

Rebuild the library from a fileStore. Clears the library and repopulates it.

Parameters:

Properties

_game

Kiwi.Game private

Defined in src\sound\AudioLibrary.ts:37

The game that the AudioLibrary belongs to.

audio

Object public

Defined in src\sound\AudioLibrary.ts:45

Contains all of the audio files that are available.