API Docs for: 0.3.0
Show:

Audio.Manager Class

Defined in: modules/Audio/Manager.js:12
Module: Audio

Manager class is utility for manage all sound in channel.

Constructor

Audio.Manager

()

Defined in modules/Audio/Manager.js:12

Methods

_handleAllInstancesReady

(
  • channel
)
private

Defined in modules/Audio/Manager.js:151

Used has callback for the allSoundsReady event.

Parameters:

  • channel Object

_tellAllInstances

(
  • command
  • [value]
)
private

Defined in modules/Audio/Manager.js:169

Applies the command to all channels.

Parameters:

  • command String

    commands availables:

    • "pause"
    • "resume"
    • "setVolume"
    • "mute"
    • "stop"
  • [value] optional

    argument

add

(
  • src
  • max
)
Number

Defined in modules/Audio/Manager.js:84

Create new channel with src and max sound instance.

Parameters:

  • src String | String

    The source(s) of channel. If many values are passed, the first compatibel are used.

  • max Number

    The number of sound allocated in this channel.

Returns:

Number: The id of the channel.

get

(
  • uniqueId
)
Object

Defined in modules/Audio/Manager.js:115

Get a channel.

Parameters:

  • uniqueId Number

    The id of the channel need get.

Returns:

Object: The channel with uniqueId.

getMasterVolume

() Number

Defined in modules/Audio/Manager.js:209

Get a current master volume.

Returns:

Number: A current master volume.

getPlayableSound

(
  • uniqueId
)
Object

Defined in modules/Audio/Manager.js:126

Get a playable sound.

Parameters:

  • uniqueId Number

    The id of the channel need get a sound.

Returns:

Object: A playable sound.

loadAll

()

Defined in modules/Audio/Manager.js:137

Load all sounds on all channels.

pause

()

Defined in modules/Audio/Manager.js:229

Pause all sound in every channel.

remove

(
  • uniqueId
)
Boolean

Defined in modules/Audio/Manager.js:99

Remove a channel.

Parameters:

  • uniqueId Number

    The id of the channel need remove.

Returns:

Boolean: True if the channel has been remove or False.

resume

()

Defined in modules/Audio/Manager.js:238

Resume all sound in every channel.

setMasterVolume

(
  • value
)

Defined in modules/Audio/Manager.js:256

Set a volume for all sound in every channel.

Parameters:

  • value Number

    The value of volume needed. min: 0.0 -> max: 1.0

setMute

(
  • isMuted
)

Defined in modules/Audio/Manager.js:219

Mute or Unmute all sound in every channel.

Parameters:

  • isMuted Boolean

    True for mute or false for unmute.

stop

()

Defined in modules/Audio/Manager.js:247

Stop all sound in every channel.

Properties

_instances

Array private

Defined in modules/Audio/Manager.js:20

Array of Channel.

Default: []

_lastId

Number private

Defined in modules/Audio/Manager.js:38

LastId of Channel.

Default: 0

_masterVolume

Number private

Defined in modules/Audio/Manager.js:73

Volume of all sound in all channel, between 0.0 and 1.0.

Default: 1

_ready

Number private

Defined in modules/Audio/Manager.js:47

Number of Channel ready to play.

Default: 0

allInstancesReady

Function

Defined in modules/Audio/Manager.js:56

Callback function when all channel is ready to play.

Default: null

instanceReady

Function

Defined in modules/Audio/Manager.js:64

Callback function when a channel is ready to play.

Default: null

Sub-properties:

  • id Number

    first callback arg; id of ready instance.

length

Number

Defined in modules/Audio/Manager.js:29

Number of Channel.

Default: 0