API Docs for: 1.4.0
Show:

Kiwi.Sound.AudioManager Class

Defined in: src\sound\AudioManager.ts:12
Module: Sound
Parent Module: Kiwi

Manages the initialisation of assets necessary when dealing with audio in the game, either through Audio Tags or the Web Audio API. Also provides global sound controls that will be applyed to all Audio objects at the same time, within the Game this manager is a part of.

Constructor

Kiwi.Sound.AudioManager

(
  • game
)
Kiwi.Sound.AudioManager

Defined in src\sound\AudioManager.ts:12

Parameters:

  • game Kiwi.Game

    The game that this audio manager belongs to.

Returns:

Kiwi.Sound.AudioManager:

Methods

_unlocked

() private

Defined in src\sound\AudioManager.ts:218

Is executed when a mouse event is fired on the device. This is used to enabled playback of sounds on the current device if they were awaiting for a user event.

add

(
  • key
  • [volume=1]
  • [loop=false]
)
Kiwi.Sound.Audio public

Defined in src\sound\AudioManager.ts:363

Used to create a new sound on the audio manager. Returns the newly created sound.

Parameters:

  • key String

    The key for the audio file that is to be loaded from the AudioLibrary.

  • [volume=1] Number optional

    The volume for the piece of audio.

  • [loop=false] Boolean optional

    If the audio should keep repeat when it gets to the end.

Returns:

Kiwi.Sound.Audio:

boot

() public

Defined in src\sound\AudioManager.ts:159

The boot method is executed when all of the DOM elements needed for the game are loaded and the game is ready to 'start' up.

isRegistered

(
  • sound
)
Boolean public

Defined in src\sound\AudioManager.ts:330

Indicates whether or not an Audio Object is registered with this Audio Manager or not. For Kiwi Internal use only.

Parameters:

  • sound Audio

    The Audio object you are checking for.

Returns:

Boolean:

If the piece of audio is registered or not.

objType

() String public

Defined in src\sound\AudioManager.ts:30

The type of object that this is.

Returns:

String:

"AudioManager"

pauseAll

() public

Defined in src\sound\AudioManager.ts:443

Pauses all of the sounds listed in the AudioManager.

playAll

() public

Defined in src\sound\AudioManager.ts:411

Plays all of the sounds listed in the AudioManager.

registerSound

(
  • sound
)
Boolean public

Defined in src\sound\AudioManager.ts:347

Registers an Audio Object with this audio manager. Also assign's the audio piece a unique ID to identify it by. Internal Kiwi use only.

Parameters:

  • sound Audio

    The audio piece you are wanting to register.

Returns:

Boolean:

Indication of if the sound was successfully added or not.

remove

(
  • sound
  • [destory=true]
)
public

Defined in src\sound\AudioManager.ts:382

Removes the passed sound from the AudioManager. If you remove a Audio Object from the AudioManager, then that Audio Object will not have a update loop.

Parameters:

  • sound Kiwi.Sound.Audio

    The Audio object that you want to remove.

  • [destory=true] Object optional

    If the Audio Object should be removed or not.

resumeAll

() public

Defined in src\sound\AudioManager.ts:460

Resumes all of the sounds listed in the AudioManager.

stopAll

() public

Defined in src\sound\AudioManager.ts:426

Stops all of the sounds that are listed in the AudioManager from playing.

update

() public

Defined in src\sound\AudioManager.ts:477

The update loop that is executed every frame.

Properties

_game

Kiwi.Game private

Defined in src\sound\AudioManager.ts:40

The game that this manager belongs to.

_locked

Boolean private

Defined in src\sound\AudioManager.ts:132

Indicates if the sounds is currently 'locked' or not. If it is 'locked' then no audio can play until a user touch's the device.

_muted

Boolean private

Defined in src\sound\AudioManager.ts:57

A boolean that controls whether the whole games audio should be muted or not.

Default: false

_muteVolume

Number private

Defined in src\sound\AudioManager.ts:124

The volume of the audio before it was muted. This is used so that when the audio is unmuted the volume will resume at this point.

_sounds

Array private

Defined in src\sound\AudioManager.ts:66

An array containing all of the sounds on the game.

_unlockedSource

Any private

Defined in src\sound\AudioManager.ts:141

Sound buffer

_volume

Number private

Defined in src\sound\AudioManager.ts:48

The global volume of all of the games audio.

Default: 1

channels

Number public

Defined in src\sound\AudioManager.ts:74

The number of channels that are supported. Not in much use at this point in time.

context

Any public

Defined in src\sound\AudioManager.ts:108

Web Audio API ONLY - The audio context that is used for decoding audio, e.t.c.

locked

Boolean public

Defined in src\sound\AudioManager.ts:149

Returns a boolean indicating whether the device has been touched or not. READ ONLY.

masterGain

Any public

Defined in src\sound\AudioManager.ts:116

Web Audio API ONLY - The master gain node through which all sounds play.

mute

Boolean public

Defined in src\sound\AudioManager.ts:246

Used to mute the audio on the device, or to check to see if the device is muted. This will not stop audio from being played, will just mean that the audio is silent.

Default: false

noAudio

Boolean public

Defined in src\sound\AudioManager.ts:83

If the current game has audio support or not. Useful because audio support is spotty in mobile browsers.

usingAudioTag

Boolean public

Defined in src\sound\AudioManager.ts:100

If the game is using audio tags for the sound. This is the fallback if the web audio api is not supported.

usingWebAudio

Boolean public

Defined in src\sound\AudioManager.ts:92

If the game is currently using the Web Audio API for the sound.

volume

Number public

Defined in src\sound\AudioManager.ts:292

Global setting and getting of the volume. A number between 0 (silence) and 1 (full volume).

Default: 1