Class Fz2D.Audio

Defined in: src/sys/audio.coffee

Overview

Public: Audio

Constant Summary

MAX_VOLUME =
Public: Maximum volume value.
100.0
FORMATS =
Public: Audio Formats.
{
  'audio/ogg': 'ogg',
  'audio/aac': 'm4a',
  'audio/x-m4a': 'm4a',
  'audio/wav': 'wav'
}

Instance Method Summary

Constructor Details

::constructor(audio = null) Source

Public: Constructor. audio - Fz2D.Audio (default: null)

Parameters:

  • (Fz2D.Audio) audioFz2D.Audio (default: null)

Instance Method Details

Fz2D.Audio ::clone() Source

Public: Clones audio Returns a Fz2D.Audio pointing to the same audio.

Returns:

::load(path) Source

Public: Loads an audio. path - relative path

Parameters:

  • pathrelative path

::onload(audio) Source

Public: On load(ed) callback. audio - Fz2D.Audio

Parameters:

::pause() Source

Public: Pauses the audio.

::play(looped) Source

Public: Play the audio.

::replay() Source

Public: Replay the audio.

::setLoop(state) Source

Public: Sets loop state. state - true or false

Parameters:

  • statetrue or false

::setVolume(volume) Source

Public: Sets volume. volume - number in the range of 0 to 100

Parameters:

  • volumenumber in the range of 0 to 100

::stop() Source

Public: Stops the audio.

::toAudio() Source

Public: Returns "native" audio instance.