audioEngine 类型

模块: cc

cc.audioengine是单例对象。
主要用来播放音频,播放的时候会返回一个 audioID,之后都可以通过这个 audioID 来操作这个音频对象。
不使用的时候,请使用 cc.audioEngine.uncache(filePath); 进行资源释放
注意:
在 Android 系统浏览器上,不同浏览器,不同版本的效果不尽相同。
比如说:大多数浏览器都需要用户物理交互才可以开始播放音效,有一些不支持 WebAudio,
有一些不支持多音轨播放。总之如果对音乐依赖比较强,请做尽可能多的测试。

索引

方法

Details

方法

play

播放音频

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:118
参数列表
  • clip AudioClip The audio clip to play.
  • loop Boolean Whether the music loop or not.
  • volume Number Volume size.
示例
cc.loader.loadRes(url, cc.AudioClip, function (err, clip) {
    var audioID = cc.audioEngine.play(clip, false, 0.5);
});
setLoop

设置音频是否循环。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:165
参数列表
示例
cc.audioEngine.setLoop(id, true);
isLoop

获取音频的循环状态。

meta description
返回 Boolean
定义于 cocos2d/audio/CCAudioEngine.js:181
参数列表
示例
cc.audioEngine.isLoop(id);
setVolume

设置音量(0.0 ~ 1.0)。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:197
参数列表
  • audioID Number audio id.
  • volume Number Volume must be in 0.0~1.0 .
示例
cc.audioEngine.setVolume(id, 0.5);
getVolume

获取音量(0.0 ~ 1.0)。

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:213
参数列表
示例
var volume = cc.audioEngine.getVolume(id);
setCurrentTime

设置当前的音频时间。

meta description
返回 Boolean
定义于 cocos2d/audio/CCAudioEngine.js:227
参数列表
示例
cc.audioEngine.setCurrentTime(id, 2);
getCurrentTime

获取当前的音频播放时间。

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:248
参数列表
示例
var time = cc.audioEngine.getCurrentTime(id);
getDuration

获取音频总时长。

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:262
参数列表
示例
var time = cc.audioEngine.getDuration(id);
getState

获取音频状态。

meta description
返回 audioEngine.AudioState
定义于 cocos2d/audio/CCAudioEngine.js:276
参数列表
示例
var state = cc.audioEngine.getState(id);
setFinishCallback

设置一个音频结束后的回调

meta description
定义于 cocos2d/audio/CCAudioEngine.js:290
参数列表
示例
cc.audioEngine.setFinishCallback(id, function () {});
pause

暂停正在播放音频。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:306
参数列表
  • audioID Number The return value of function play.
示例
cc.audioEngine.pause(audioID);
pauseAll

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

meta description
定义于 cocos2d/audio/CCAudioEngine.js:326
示例
cc.audioEngine.pauseAll();
resume

恢复播放指定的音频。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:344
参数列表
  • audioID Number The return value of function play.
示例
cc.audioEngine.resume(audioID);
resumeAll

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

meta description
定义于 cocos2d/audio/CCAudioEngine.js:359
示例
cc.audioEngine.resumeAll();
stop

停止播放指定音频。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:376
参数列表
  • audioID Number The return value of function play.
示例
cc.audioEngine.stop(audioID);
stopAll

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

meta description
定义于 cocos2d/audio/CCAudioEngine.js:396
示例
cc.audioEngine.stopAll();
setMaxAudioInstance

设置一个音频可以设置几个实例

meta description
定义于 cocos2d/audio/CCAudioEngine.js:413
参数列表
  • num Number a number of instances to be created from within an audio
示例
cc.audioEngine.setMaxAudioInstance(20);
getMaxAudioInstance

获取一个音频可以设置几个实例

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:425
示例
cc.audioEngine.getMaxAudioInstance();
uncache

卸载预加载的音频。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:437
参数列表
示例
cc.audioEngine.uncache(filePath);
uncacheAll

卸载所有音频。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:472
示例
cc.audioEngine.uncacheAll();
preload

预加载一个音频

meta description
定义于 cocos2d/audio/CCAudioEngine.js:503
废弃(Deprecated) `cc.audioEngine.preload` is deprecated, use `cc.loader.loadRes(url, cc.AudioClip)` instead please.
参数列表
  • filePath String The file path of an audio.
  • callback Function The callback of an audio.
示例
cc.audioEngine.preload(path);
setMaxWebAudioSize

设置一个以 KB 为单位的尺寸,大于这个尺寸的音频在加载的时候会强制使用 dom 方式加载

meta description
定义于 cocos2d/audio/CCAudioEngine.js:525
参数列表
  • kb Number The file path of an audio.
示例
cc.audioEngine.setMaxWebAudioSize(300);
playMusic

播放背景音乐

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:577
参数列表
  • clip AudioClip The audio clip to play.
  • loop Boolean Whether the music loop or not.
示例
cc.loader.loadRes(url, cc.AudioClip, function (err, clip) {
    var audioID = cc.audioEngine.playMusic(clip, false);
});
stopMusic

停止播放背景音乐。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:597
示例
cc.audioEngine.stopMusic();
pauseMusic

暂停播放背景音乐。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:608
示例
cc.audioEngine.pauseMusic();
resumeMusic

恢复播放背景音乐。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:620
示例
cc.audioEngine.resumeMusic();
getMusicVolume

获取音量(0.0 ~ 1.0)。

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:632
示例
var volume = cc.audioEngine.getMusicVolume();
setMusicVolume

设置背景音乐音量(0.0 ~ 1.0)。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:644
参数列表
  • volume Number Volume must be in 0.0~1.0.
示例
cc.audioEngine.setMusicVolume(0.5);
isMusicPlaying

背景音乐是否正在播放

meta description
返回 Boolean
定义于 cocos2d/audio/CCAudioEngine.js:659
示例
cc.audioEngine.isMusicPlaying();
playEffect

播放音效

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:671
参数列表
  • clip AudioClip The audio clip to play.
  • loop Boolean Whether the music loop or not.
示例
cc.loader.loadRes(url, cc.AudioClip, function (err, clip) {
    var audioID = cc.audioEngine.playEffect(clip, false);
});
setEffectsVolume

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

meta description
定义于 cocos2d/audio/CCAudioEngine.js:687
参数列表
  • volume Number Volume must be in 0.0~1.0.
示例
cc.audioEngine.setEffectsVolume(0.5);
getEffectsVolume

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

meta description
返回 Number
定义于 cocos2d/audio/CCAudioEngine.js:705
示例
var volume = cc.audioEngine.getEffectsVolume();
pauseEffect

暂停播放音效。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:717
参数列表
示例
cc.audioEngine.pauseEffect(audioID);
pauseAllEffects

暂停播放所有音效。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:729
示例
cc.audioEngine.pauseAllEffects();
resumeEffect

恢复播放音效音频。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:752
参数列表
  • audioID Number The return value of function play.
示例
cc.audioEngine.resumeEffect(audioID);
resumeAllEffects

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

meta description
定义于 cocos2d/audio/CCAudioEngine.js:764
示例
cc.audioEngine.resumeAllEffects();
stopEffect

停止播放音效。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:781
参数列表
示例
cc.audioEngine.stopEffect(id);
stopAllEffects

停止播放所有音效。

meta description
定义于 cocos2d/audio/CCAudioEngine.js:793
示例
cc.audioEngine.stopAllEffects();

results matching ""

    No results matching ""