Cocos Creator API

0.7.1

Cocos Creator is a highly customizable game development tool that utilizes the power of cocos2d-x.

audioEngine

Module: cc

cc.audioEngine is the singleton object, it provide simple audio APIs.

Methods

willPlayMusic ( ) boolean

Indicates whether any background music can be played or not.

returns:

type: boolean

true if the background music is playing, otherwise false

playMusic
(
  • url
  • loop
)

Play music.

name type description
url String

The path of the music file without filename extension.
loop Boolean

Whether the music loop or not.

examples:

//example
cc.audioEngine.playMusic(path, false);

stopMusic
(
  • [releaseData ]
)

Stop playing music.

name type description
releaseData optional Boolean

If release the music data or not.As default value is false.

examples:

//example
cc.audioEngine.stopMusic();

pauseMusic ( )

Pause playing music.

examples:

//example
cc.audioEngine.pauseMusic();

resumeMusic ( )

Resume playing music.

examples:

//example
cc.audioEngine.resumeMusic();

rewindMusic ( )

Rewind playing music.

examples:

//example
cc.audioEngine.rewindMusic();

getMusicVolume ( ) Number

The volume of the music max value is 1.0,the min value is 0.0 .

returns:

type: Number

examples:

//example
var volume = cc.audioEngine.getMusicVolume();

setMusicVolume
(
  • volume
)

Set the volume of music.

name type description
volume Number

Volume must be in 0.0~1.0 .

examples:

//example
cc.audioEngine.setMusicVolume(0.5);

isMusicPlaying ( ) Boolean

Whether the music is playing.

returns:

type: Boolean

If is playing return true,or return false.

examples:

//example
 if (cc.audioEngine.isMusicPlaying()) {
     cc.log("music is playing");
 }
 else {
     cc.log("music is not playing");
 }

playEffect
(
  • url
  • loop
)
Number | Null

Play sound effect.

name type description
url String

The path of the sound effect with filename extension.
loop Boolean

Whether to loop the effect playing, default value is false

returns:

type: Number | Null

the audio id

examples:

//example
var soundId = cc.audioEngine.playEffect(path);

setEffectsVolume
(
  • volume
)

Set the volume of sound effects.

name type description
volume Number

Volume must be in 0.0~1.0 .

examples:

//example
cc.audioEngine.setEffectsVolume(0.5);

getEffectsVolume ( ) Number

The volume of the effects max value is 1.0,the min value is 0.0 .

returns:

type: Number

examples:

//example
var effectVolume = cc.audioEngine.getEffectsVolume();

pauseEffect
(
  • cc.Audio
)

Pause playing sound effect.

name type description
cc.Audio Number

The return value of function playEffect.

examples:

//example
cc.audioEngine.pauseEffect(audioID);

pauseAllEffects ( )

Pause all playing sound effect.

examples:

//example
cc.audioEngine.pauseAllEffects();

resumeEffect
(
  • cc.Audio
)

Resume playing sound effect.

name type description
cc.Audio Number

The return value of function playEffect.

resumeAllEffects ( )

Resume all playing sound effect

examples:

//example
cc.audioEngine.resumeAllEffects();

stopEffect
(
  • cc.Audio
)

Stop playing sound effect.

name type description
cc.Audio Number

The return value of function playEffect.

examples:

//example
cc.audioEngine.stopEffect(audioID);

stopAllEffects ( )

Stop all playing sound effects.

examples:

//example
cc.audioEngine.stopAllEffects();

unloadEffect
(
  • url
)

Unload the preloaded effect from internal buffer

name type description
url String

examples:

//example
cc.audioEngine.unloadEffect(EFFECT_FILE);

end ( )

End music and effects.

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index