Namespace cc.audioEngine

A simple Audio Engine engine API.

Method Summary

Method Detail

  • end()
    End music and effects.
  • {Number} getEffectsVolume()
    The volume of the effects max value is 1.0,the min value is 0.0 . 
    //example
var effectVolume = cc.audioEngine.getEffectsVolume();
    Returns:
    {Number}
  • {Number} getMusicVolume()
    The volume of the music max value is 1.0,the min value is 0.0 . 
    //example
var volume = cc.audioEngine.getMusicVolume();
    Returns:
    {Number}
  • {Boolean} isMusicPlaying()
    Whether the music is playing. 
    //example
 if (cc.audioEngine.isMusicPlaying()) {
     cc.log("music is playing");
 }
 else {
     cc.log("music is not playing");
 }
    Returns:
    {Boolean} If is playing return true,or return false.
  • pauseAllEffects()
    Pause all playing sound effect. 
    //example
cc.audioEngine.pauseAllEffects();
  • pauseEffect(audioID)
    Pause playing sound effect. 
    //example
cc.audioEngine.pauseEffect(audioID);
    Parameters:
    {Number} audioID
    The return value of function playEffect.
  • pauseMusic()
    Pause playing music. 
    //example
cc.audioEngine.pauseMusic();
  • {Number|null} playEffect(url, loop)
    Play sound effect. 
    //example
var soundId = cc.audioEngine.playEffect(path);
    Parameters:
    {String} url
    The path of the sound effect with filename extension.
    {Boolean} loop
    Whether to loop the effect playing, default value is false
    Returns:
    {Number|null} the audio id
  • playMusic(url, loop)
    Play music. 
    //example
cc.audioEngine.playMusic(path, false);
    Parameters:
    {String} url
    The path of the music file without filename extension.
    {Boolean} loop
    Whether the music loop or not.
  • resumeAllEffects()
    Resume all playing sound effect 
    //example
cc.audioEngine.resumeAllEffects();
  • resumeEffect(effectId)
    Resume playing sound effect.
    Parameters:
    {Number} effectId
    The return value of function playEffect.
  • resumeMusic()
    Resume playing music. 
    //example
cc.audioEngine.resumeMusic();
  • rewindMusic()
    Rewind playing music. 
    //example
cc.audioEngine.rewindMusic();
  • setEffectsVolume(volume)
    Set the volume of sound effects. 
    //example
cc.audioEngine.setEffectsVolume(0.5);
    Parameters:
    {Number} volume
    Volume must be in 0.0~1.0 .
  • setMusicVolume(volume)
    Set the volume of music. 
    //example
cc.audioEngine.setMusicVolume(0.5);
    Parameters:
    {Number} volume
    Volume must be in 0.0~1.0 .
  • stopAllEffects()
    Stop all playing sound effects. 
    //example
cc.audioEngine.stopAllEffects();
  • stopEffect(effectId)
    Stop playing sound effect. 
    //example
cc.audioEngine.stopEffect(audioID);
    Parameters:
    {Number} effectId
    The return value of function playEffect.
  • stopMusic(releaseData)
    Stop playing music. 
    //example
cc.audioEngine.stopMusic();
    Parameters:
    {Boolean} releaseData
    If release the music data or not.As default value is false.
  • unloadEffect(url)
    Unload the preloaded effect from internal buffer 
    //example
cc.audioEngine.unloadEffect(EFFECT_FILE);
    Parameters:
    {String} url
  • {boolean} willPlayMusic()
    Indicates whether any background music can be played or not.
    Returns:
    {boolean} true if the background music is playing, otherwise false