audioEngine Class

Module: cc

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

Index

Methods

Details

Methods

play

Play audio.

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:136
Parameters
  • clip AudioClip The audio clip to play.
  • loop Boolean Whether the music loop or not.
  • volume Number Volume size.
Examples
cc.resources.load(path, cc.AudioClip, null, function (err, clip) {
    var audioID = cc.audioEngine.play(clip, false, 0.5);
});
setLoop

Set audio loop.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:164
Parameters
Examples
cc.audioEngine.setLoop(id, true);
isLoop

Get audio cycle state.

meta description
Returns Boolean
Defined in cocos2d/audio/CCAudioEngine.js:180
Parameters
Examples
cc.audioEngine.isLoop(id);
setVolume

Set the volume of audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:196
Parameters
  • audioID Number audio id.
  • volume Number Volume must be in 0.0~1.0 .
Examples
cc.audioEngine.setVolume(id, 0.5);
getVolume

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

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:212
Parameters
Examples
var volume = cc.audioEngine.getVolume(id);
setCurrentTime

Set current time

meta description
Returns Boolean
Defined in cocos2d/audio/CCAudioEngine.js:226
Parameters
Examples
cc.audioEngine.setCurrentTime(id, 2);
getCurrentTime

Get current time

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:247
Parameters
Examples
var time = cc.audioEngine.getCurrentTime(id);
getDuration

Get audio duration

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:261
Parameters
Examples
var time = cc.audioEngine.getDuration(id);
getState

Get audio state

meta description
Returns audioEngine.AudioState
Defined in cocos2d/audio/CCAudioEngine.js:275
Parameters
Examples
var state = cc.audioEngine.getState(id);
setFinishCallback

Set Audio finish callback

meta description
Defined in cocos2d/audio/CCAudioEngine.js:289
Parameters
Examples
cc.audioEngine.setFinishCallback(id, function () {});
pause

Pause playing audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:305
Parameters
  • audioID Number The return value of function play.
Examples
cc.audioEngine.pause(audioID);
pauseAll

Pause all playing audio

meta description
Defined in cocos2d/audio/CCAudioEngine.js:325
Examples
cc.audioEngine.pauseAll();
resume

Resume playing audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:343
Parameters
  • audioID Number The return value of function play.
Examples
cc.audioEngine.resume(audioID);
resumeAll

Resume all playing audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:358
Examples
cc.audioEngine.resumeAll();
stop

Stop playing audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:375
Parameters
  • audioID Number The return value of function play.
Examples
cc.audioEngine.stop(audioID);
stopAll

Stop all playing audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:395
Examples
cc.audioEngine.stopAll();
setMaxAudioInstance

Set up an audio can generate a few examples.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:412
Deprecated since v2.4.0
Parameters
  • num Number a number of instances to be created from within an audio
Examples
cc.audioEngine.setMaxAudioInstance(20);
getMaxAudioInstance

Getting audio can produce several examples.

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:428
Examples
cc.audioEngine.getMaxAudioInstance();
uncache

Unload the preloaded audio from internal buffer.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:440
Parameters
Examples
cc.audioEngine.uncache(filePath);
uncacheAll

Unload all audio from internal buffer.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:475
Examples
cc.audioEngine.uncacheAll();
playMusic

Play background music

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:537
Parameters
  • clip AudioClip The audio clip to play.
  • loop Boolean Whether the music loop or not.
Examples
cc.resources.load(path, cc.AudioClip, null, function (err, clip) {
    var audioID = cc.audioEngine.playMusic(clip, false);
});
stopMusic

Stop background music.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:557
Examples
cc.audioEngine.stopMusic();
pauseMusic

Pause the background music.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:568
Examples
cc.audioEngine.pauseMusic();
resumeMusic

Resume playing background music.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:580
Examples
cc.audioEngine.resumeMusic();
getMusicVolume

Get the volume(0.0 ~ 1.0).

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:592
Examples
var volume = cc.audioEngine.getMusicVolume();
setMusicVolume

Set the background music volume.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:604
Parameters
  • volume Number Volume must be in 0.0~1.0.
Examples
cc.audioEngine.setMusicVolume(0.5);
isMusicPlaying

Background music playing state

meta description
Returns Boolean
Defined in cocos2d/audio/CCAudioEngine.js:620
Examples
cc.audioEngine.isMusicPlaying();
playEffect

Play effect audio.

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:632
Parameters
  • clip AudioClip The audio clip to play.
  • loop Boolean Whether the music loop or not.
Examples
cc.resources.load(path, cc.AudioClip, null, function (err, clip) {
    var audioID = cc.audioEngine.playEffect(clip, false);
});
setEffectsVolume

Set the volume of effect audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:648
Parameters
  • volume Number Volume must be in 0.0~1.0.
Examples
cc.audioEngine.setEffectsVolume(0.5);
getEffectsVolume

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

meta description
Returns Number
Defined in cocos2d/audio/CCAudioEngine.js:667
Examples
var volume = cc.audioEngine.getEffectsVolume();
pauseEffect

Pause effect audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:679
Parameters
Examples
cc.audioEngine.pauseEffect(audioID);
pauseAllEffects

Stop playing all the sound effects.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:691
Examples
cc.audioEngine.pauseAllEffects();
resumeEffect

Resume effect audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:714
Parameters
  • audioID Number The return value of function play.
Examples
cc.audioEngine.resumeEffect(audioID);
resumeAllEffects

Resume all effect audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:726
Examples
cc.audioEngine.resumeAllEffects();
stopEffect

Stop playing the effect audio.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:743
Parameters
Examples
cc.audioEngine.stopEffect(id);
stopAllEffects

Stop playing all the effects.

meta description
Defined in cocos2d/audio/CCAudioEngine.js:755
Examples
cc.audioEngine.stopAllEffects();

results matching ""

    No results matching ""