Cocos Creator API

1.2.0

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

audioEngine

模块: cc

zn cc.audioengine是单例对象。
主要用来播放背景音乐和音效,背景音乐同一时间只能播放一个,而音效则可以同时播放多个。
注意:
在 Android 系统浏览器上,不同浏览器,不同版本的效果不尽相同。
比如说:大多数浏览器都需要用户物理交互才可以开始播放音效,有一些不支持 WebAudio,
有一些不支持多音轨播放。总之如果对音乐依赖比较强,请做尽可能多的测试。

方法

playMusic
(
  • url
  • loop
)

播放指定音乐,并可以设置是否循环播放。
注意:音乐播放接口不支持多音轨,同一时间只能播放一个音乐。

名称 类型 描述
url String

The path of the music file without filename extension.

loop Boolean

Whether the music loop or not.

示例:

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

stopMusic
(
  • [releaseData ]
)

停止当前音乐。

名称 类型 描述
releaseData optional Boolean

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

示例:

//example
cc.audioEngine.stopMusic();

pauseMusic ( )

暂停正在播放音乐。

示例:

//example
cc.audioEngine.pauseMusic();

resumeMusic ( )

恢复音乐播放。

示例:

//example
cc.audioEngine.resumeMusic();

rewindMusic ( )

从头开始重新播放当前音乐。

示例:

//example
cc.audioEngine.rewindMusic();

getMusicVolume ( ) Number

获取音量(0.0 ~ 1.0)。

返回:

类型: Number

示例:

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

setMusicVolume
(
  • volume
)

设置音量(0.0 ~ 1.0)。

名称 类型 描述
volume Number

Volume must be in 0.0~1.0 .

示例:

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

isMusicPlaying ( ) Boolean

音乐是否正在播放。

返回:

类型: Boolean

If is playing return true,or return false.

示例:

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

playEffect
(
  • url
  • loop
  • volume
)
Number | Null

播放指定音效,并可以设置是否循环播放。
注意:在部分不支持多音轨的浏览器上,这个接口会失效,请使用 playMusic

名称 类型 描述
url String

The path of the sound effect with filename extension.

loop Boolean

Whether to loop the effect playing, default value is false

volume Boolean

返回:

类型: Number | Null

the audio id

示例:

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

setEffectsVolume
(
  • volume
)

设置音效音量(0.0 ~ 1.0)。

名称 类型 描述
volume Number

Volume must be in 0.0~1.0 .

示例:

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

getEffectsVolume ( ) Number

获取音效音量(0.0 ~ 1.0)。

返回:

类型: Number

示例:

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

pauseEffect
(
  • audio
)

暂停指定的音效。

名称 类型 描述
audio Number

The return value of function playEffect.

示例:

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

pauseAllEffects ( )

暂停现在正在播放的所有音效。

示例:

//example
cc.audioEngine.pauseAllEffects();

resumeEffect
(
  • audioID
)

恢复播放指定的音效。

名称 类型 描述
audioID Number

The return value of function playEffect.

resumeAllEffects ( )

恢复播放所有之前暂停的所有音效。

示例:

//example
cc.audioEngine.resumeAllEffects();

stopEffect
(
  • audioID
)

停止播放指定音效。

名称 类型 描述
audioID Number

The return value of function playEffect.

示例:

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

stopAllEffects ( )

停止正在播放的所有音效。

示例:

//example
cc.audioEngine.stopAllEffects();

unloadEffect
(
  • url
)

卸载预加载的音效。

名称 类型 描述
url String

示例:

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

end ( )

停止所有音乐和音效的播放。

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