API Docs for: 0.3.0
Show:

Audio.Sound Class

Defined in: modules/Audio/Sound.js:20
Module: Audio

Sound class is object represent html5 sound tag.

Constructor

Audio.Sound

(
  • src
)

Defined in modules/Audio/Sound.js:20

Parameters:

  • src String | String

    The sound source url. If an array is passed, the first supported source is used, so provide the same sound in many formats is recommended.

Methods

_choosePath

(
  • sources
)
String private

Defined in modules/Audio/Sound.js:153

choose a compatible source for audio tag.

Parameters:

  • sources String | String

    url or array of urls for source audio file.

Returns:

String: the first copmpatible url if any; null otherwise.

_playFailed

() private

Defined in modules/Audio/Sound.js:177

Called when an error occurs for cleaning audio tag.

_updateVolume

() private

Defined in modules/Audio/Sound.js:313

Applies all volume modifications.

getDuration

() Number

Defined in modules/Audio/Sound.js:364

Get current sound duration.

Returns:

Number: A current sound duration.

getPosition

() Number

Defined in modules/Audio/Sound.js:344

Get current sound offset.

Returns:

Number: A current sound offset.

getVolume

() Number

Defined in modules/Audio/Sound.js:323

Get current sound volume.

Returns:

Number: A current sound volume.

load

(
  • offset
  • loop
  • volume
)
Boolean

Defined in modules/Audio/Sound.js:192

Load sound and call onReady callback when load finish.

Parameters:

  • offset Number

    The offset where sound start.

  • loop Number

    The number of loop where sound played.

  • volume Number

    The volume of sound.

Returns:

Boolean: true if sound begin the loading or false if the sound loading is impossible.

mute

(
  • isMuted
)

Defined in modules/Audio/Sound.js:333

Mute or Unmute all sound in this channel.

Parameters:

  • isMuted Boolean

    True for mute or false for unmute.

mute

(
  • value
)

Defined in modules/Audio/Sound.js:300

Set current sound volume.

Parameters:

  • value Number

    sound volume, between 0.0 and 1.0.

pause

()

Defined in modules/Audio/Sound.js:269

Pause sound.

play

()

Defined in modules/Audio/Sound.js:259

Start play sound.

resume

()

Defined in modules/Audio/Sound.js:279

Resume sound.

setPosition

(
  • value
)

Defined in modules/Audio/Sound.js:354

Set current sound offset.

Parameters:

  • value Number

    The value of offset.

stop

()

Defined in modules/Audio/Sound.js:289

Stop sound.

Properties

_muted

Boolean private

Defined in modules/Audio/Sound.js:66

Mute state.

Default: false

_volume

Number private

Defined in modules/Audio/Sound.js:49

Audio volume, between 0.0 and 1.0

Default: 1.0

audio

Object

Defined in modules/Audio/Sound.js:116

Html5 tag audio capabilities. Indicates for each format if it is supported by the navigator.

Supported format are mp3, ogg and wav.

Example:

{ mp3: true, ogg: false, wav: true }

audio

Object

Defined in modules/Audio/Sound.js:108

Html5 tag audio.

offset

Number private

Defined in modules/Audio/Sound.js:40

Audio offset.

Default: 0

onComplete

Function

Defined in modules/Audio/Sound.js:84

Callback function when sound play is complete.

Default: null

onLoop

Function

Defined in modules/Audio/Sound.js:92

Callback called when sound play restart loop.

Default: null

onReady

Function

Defined in modules/Audio/Sound.js:100

Callback called when sound is ready to play.

Default: null

paused

Boolean

Defined in modules/Audio/Sound.js:75

Pause state.

Default: false

playState

String

Defined in modules/Audio/Sound.js:30

Audio play state.

Default: null

remainingLoops

Number

Defined in modules/Audio/Sound.js:58

Number of loop remaining to play.

Default: 0

src

String

Defined in modules/Audio/Sound.js:135

Audio source file, used by the audio element.

Even if many paths are passed to constructor, src contain only that which is currently used.