API Docs for: 0.3.0
Show:

Audio.Channel Class

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

Channel class is utility for manage multiple sound with same source.

Constructor

Audio.Channel

(
  • src
  • max
  • id
)

Defined in modules/Audio/Channel.js:12

Parameters:

  • src String | String

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

  • max Number

    The number of sound allocated in this channel.

  • id Number

    The identifier of the channel.

Methods

_tellAllSounds

(
  • command
  • [value]
)
private

Defined in modules/Audio/Channel.js:112

Applies the command to all sounds.

Parameters:

  • command String

    commands availables:

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

    argument

add

(
  • max
)

Defined in modules/Audio/Channel.js:61

Add max sound instance with sources in channel.

Parameters:

  • max Number

    The number of sound allocated in this channel.

getPlayableSound

() Object

Defined in modules/Audio/Channel.js:95

Get a playable sound.

Returns:

Object: A playable sound.

load

()

Defined in modules/Audio/Channel.js:74

Load all sound.

pause

()

Defined in modules/Audio/Channel.js:162

Pause all sound in this channel.

resume

()

Defined in modules/Audio/Channel.js:171

Resume all sound in this channel.

setMasterVolume

(
  • value
)

Defined in modules/Audio/Channel.js:189

Set a volume for all sound in this channel.

Parameters:

  • value Number

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

setMute

(
  • isMuted
)

Defined in modules/Audio/Channel.js:152

Mute or Unmute all sound in this channel.

Parameters:

  • isMuted Boolean

    True for mute or false for unmute.

stop

()

Defined in modules/Audio/Channel.js:180

Stop all sound in this channel.

Properties

_sounds

Sound

Defined in modules/Audio/Channel.js:24

Array of Sound.

Default: []

_src

String | String private

Defined in modules/Audio/Channel.js:40

Source sound for this channel. Can contains many values (first compatible are used).

allSoundsReady

Function

Defined in modules/Audio/Channel.js:32

Callback function when all sound is ready to play in this channel.

Default: null

id

Number

Defined in modules/Audio/Channel.js:49

Channel id.

Default: id