audioEngine Class

Module: cc

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

Index

Methods

• play Play audio.
• setLoop Set audio loop.
• isLoop Get audio cycle state.
• setVolume Set the volume of audio.
• getVolume The volume of the music max value is 1.0,the min value is 0.0 .
• setCurrentTime Set current time
• getCurrentTime Get current time
• getDuration Get audio duration
• getState Get audio state
• setFinishCallback Set Audio finish callback
• pause Pause playing audio.
• pauseAll Pause all playing audio
• resume Resume playing audio.
• resumeAll Resume all playing audio.
• stop Stop playing audio.
• stopAll Stop all playing audio.
• setMaxAudioInstance Set up an audio can generate a few examples.
• getMaxAudioInstance Getting audio can produce several examples.
• uncache Unload the preloaded audio from internal buffer.
• uncacheAll Unload all audio from internal buffer.
• preload Preload audio file.
• setMaxWebAudioSize Set a size, the unit is KB.
• playMusic Play background music
• stopMusic Stop background music.
• pauseMusic Pause the background music.
• resumeMusic Resume playing background music.
• getMusicVolume Get the volume(0.0 ~ 1.0).
• setMusicVolume Set the background music volume.
• isMusicPlaying Background music playing state
• playEffect Play effect audio.
• setEffectsVolume Set the volume of effect audio.
• getEffectsVolume The volume of the effect audio max value is 1.0,the min value is 0.0 .
• pauseEffect Pause effect audio.
• pauseAllEffects Stop playing all the sound effects.
• resumeEffect Resume effect audio.
• resumeAllEffects Resume all effect audio.
• stopEffect Stop playing the effect audio.
• stopAllEffects Stop playing all the effects.

Details

Methods

play

Play audio.

Parameters

• clip AudioClip The audio clip to play.
• loop Boolean Whether the music loop or not.
• volume Number Volume size.

Examples

cc.loader.loadRes(url, cc.AudioClip, function (err, clip) {
    var audioID = cc.audioEngine.play(clip, false, 0.5);
});

setLoop

Set audio loop.

Parameters

• audioID Number audio id.
• loop Boolean Whether cycle.

Examples

cc.audioEngine.setLoop(id, true);

isLoop

Get audio cycle state.

Parameters

• audioID Number audio id.

Examples

cc.audioEngine.isLoop(id);

setVolume

Set the volume of audio.

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 .

Parameters

• audioID Number audio id.

Examples

var volume = cc.audioEngine.getVolume(id);

setCurrentTime

Set current time

Parameters

• audioID Number audio id.
• sec Number current time.

Examples

cc.audioEngine.setCurrentTime(id, 2);

getCurrentTime

Get current time

Parameters

• audioID Number audio id.

Examples

var time = cc.audioEngine.getCurrentTime(id);

getDuration

Get audio duration

Parameters

• audioID Number audio id.

Examples

var time = cc.audioEngine.getDuration(id);

getState

Get audio state

Parameters

• audioID Number audio id.

Examples

var state = cc.audioEngine.getState(id);

setFinishCallback

Set Audio finish callback

Parameters

• audioID Number audio id.
• callback Function loaded callback.

Examples

cc.audioEngine.setFinishCallback(id, function () {});

pause

Pause playing audio.

Parameters

• audioID Number The return value of function play.

Examples

cc.audioEngine.pause(audioID);

pauseAll

Pause all playing audio

Examples

cc.audioEngine.pauseAll();

resume

Resume playing audio.

Parameters

• audioID Number The return value of function play.

Examples

cc.audioEngine.resume(audioID);

resumeAll

Resume all playing audio.

Examples

cc.audioEngine.resumeAll();

stop

Stop playing audio.

Parameters

• audioID Number The return value of function play.

Examples

cc.audioEngine.stop(audioID);

stopAll

Stop all playing audio.

Examples

cc.audioEngine.stopAll();

setMaxAudioInstance

Set up an audio can generate a few examples.

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.

Examples

cc.audioEngine.getMaxAudioInstance();

uncache

Unload the preloaded audio from internal buffer.

Parameters

• clip AudioClip

Examples

cc.audioEngine.uncache(filePath);

uncacheAll

Unload all audio from internal buffer.

Examples

cc.audioEngine.uncacheAll();

preload

Preload audio file.

Parameters

• filePath String The file path of an audio.
• callback Function The callback of an audio.

Examples

cc.audioEngine.preload(path);

setMaxWebAudioSize

Set a size, the unit is KB. Over this size is directly resolved into DOM nodes.

Parameters

• kb Number The file path of an audio.

Examples

cc.audioEngine.setMaxWebAudioSize(300);

playMusic

Play background music

Parameters

• clip AudioClip The audio clip to play.
• loop Boolean Whether the music loop or not.

Examples

cc.loader.loadRes(url, cc.AudioClip, function (err, clip) {
    var audioID = cc.audioEngine.playMusic(clip, false);
});

stopMusic

Stop background music.

Examples

cc.audioEngine.stopMusic();

pauseMusic

Pause the background music.

Examples

cc.audioEngine.pauseMusic();

resumeMusic

Resume playing background music.

Examples

cc.audioEngine.resumeMusic();

getMusicVolume

Get the volume(0.0 ~ 1.0).

Examples

var volume = cc.audioEngine.getMusicVolume();

setMusicVolume

Set the background music volume.

Parameters

• volume Number Volume must be in 0.0~1.0.

Examples

cc.audioEngine.setMusicVolume(0.5);

isMusicPlaying

Background music playing state

Examples

cc.audioEngine.isMusicPlaying();

playEffect

Play effect audio.

Parameters

• clip AudioClip The audio clip to play.
• loop Boolean Whether the music loop or not.

Examples

cc.loader.loadRes(url, cc.AudioClip, function (err, clip) {
    var audioID = cc.audioEngine.playEffect(clip, false);
});

setEffectsVolume

Set the volume of effect audio.

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 .

Examples

var volume = cc.audioEngine.getEffectsVolume();

pauseEffect

Pause effect audio.

Parameters

• audioID Number audio id.

Examples

cc.audioEngine.pauseEffect(audioID);

pauseAllEffects

Stop playing all the sound effects.

Examples

cc.audioEngine.pauseAllEffects();

resumeEffect

Resume effect audio.

Parameters

• audioID Number The return value of function play.

Examples

cc.audioEngine.resumeEffect(audioID);

resumeAllEffects

Resume all effect audio.

Examples

cc.audioEngine.resumeAllEffects();

stopEffect

Stop playing the effect audio.

Parameters

• audioID Number audio id.

Examples

cc.audioEngine.stopEffect(id);

stopAllEffects

Stop playing all the effects.

Examples

cc.audioEngine.stopAllEffects();