Files
cocos4/cocos2d/core/components/CCAudioSource.js
T
2017-07-17 14:55:38 +08:00

358 lines
9.6 KiB
JavaScript

/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Chukong Aipu reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
/**
* !#en Audio Source.
* !#zh 音频源组件,能对音频剪辑。
* @class AudioSource
* @extends Component
*/
var AudioSource = cc.Class({
name: 'cc.AudioSource',
extends: require('./CCComponent'),
editor: CC_EDITOR && {
menu: 'i18n:MAIN_MENU.component.others/AudioSource',
help: 'i18n:COMPONENT.help_url.audiosource',
},
ctor: function () {
this.audio = new cc.Audio();
},
properties: {
_clip: {
default: '',
url: cc.AudioClip
},
_volume: 1,
_mute: false,
_loop: false,
_pausedFlag: {
default: false,
serializable: false
},
/**
* !#en
* Is the audio source playing (Read Only). <br/>
* Note: isPlaying is not supported for Native platforms.
* !#zh
* 该音频剪辑是否正播放(只读)。<br/>
* 注意:Native 平台暂时不支持 isPlaying。
* @property isPlaying
* @type {Boolean}
* @readOnly
* @default false
*/
isPlaying: {
get: function () {
if (!this.audio) return false;
var state = this.audio.getState();
return state === cc.Audio.State.PLAYING;
},
visible: false
},
/**
* !#en The clip of the audio source.
* !#zh 默认要播放的音频剪辑。
* @property clip
* @type {AudioClip}
* @default 1
*/
clip: {
get: function () {
return this._clip;
},
set: function (value) {
if (value === this._clip) {
return;
}
this._clip = value;
this.audio.stop();
this.audio.src = this._clip;
if (this.audio.preload) {
this.audio.preload();
}
},
url: cc.AudioClip,
tooltip: CC_DEV && 'i18n:COMPONENT.audio.clip',
animatable: false
},
/**
* !#en The volume of the audio source.
* !#zh 音频源的音量(0.0 ~ 1.0)。
* @property volume
* @type {Number}
* @default 1
*/
volume: {
get: function () {
return this._volume;
},
set: function (value) {
value = cc.clamp01(value);
this._volume = value;
var audio = this.audio;
if (audio && !this._mute) {
audio.setVolume(value);
if (!audio._loaded) {
audio.on('load', function () {
audio.setVolume(value);
});
}
}
return value;
},
tooltip: CC_DEV && 'i18n:COMPONENT.audio.volume'
},
/**
* !#en Is the audio source mute?
* !#zh 是否静音音频源。Mute 是设置音量为 0,取消静音是恢复原来的音量。
* @property mute
* @type {Boolean}
* @default false
*/
mute: {
get: function () {
return this._mute;
},
set: function (value) {
this._mute = value;
if (this.audio) {
this.audio.setVolume(value ? 0 : this._volume);
}
return value;
},
animatable: false,
tooltip: CC_DEV && 'i18n:COMPONENT.audio.mute',
},
/**
* !#en Is the audio source looping?
* !#zh 音频源是否循环播放?
* @property loop
* @type {Boolean}
* @default false
*/
loop: {
get: function () {
return this._loop;
},
set: function (value) {
this._loop = value;
if (this.audio) {
this.audio.setLoop(value);
}
return value;
},
animatable: false,
tooltip: CC_DEV && 'i18n:COMPONENT.audio.loop'
},
/**
* !#en If set to true, the audio source will automatically start playing on onLoad.
* !#zh 如果设置为true,音频源将在 onLoad 时自动播放。
* @property playOnLoad
* @type {Boolean}
* @default true
*/
playOnLoad: {
default: false,
tooltip: CC_DEV && 'i18n:COMPONENT.audio.play_on_load',
animatable: false
},
preload: {
default: false,
animatable: false
}
},
_pausedCallback: function () {
var audio = this.audio;
if (!audio || audio.paused) return;
this.audio.pause();
this._pausedFlag = true;
},
_restoreCallback: function () {
if (!this.audio) return;
if (this._pausedFlag) {
this.audio.resume();
}
this._pausedFlag = false;
},
onEnable: function () {
if ( this.playOnLoad ) {
this.play();
}
if ( this.preload ) {
this.audio.src = this._clip;
this.audio.preload();
}
cc.game.on(cc.game.EVENT_HIDE, this._pausedCallback, this);
cc.game.on(cc.game.EVENT_SHOW, this._restoreCallback, this);
},
onDisable: function () {
this.stop();
cc.game.off(cc.game.EVENT_HIDE, this._pausedCallback, this);
cc.game.off(cc.game.EVENT_SHOW, this._restoreCallback, this);
},
onDestroy: function () {
this.stop();
cc.audioEngine.uncache(this._clip);
},
/**
* !#en Plays the clip.
* !#zh 播放音频剪辑。
* @method play
*/
play: function () {
if ( !this._clip ) return;
var volume = this._mute ? 0 : this._volume;
var audio = this.audio;
var loop = this._loop;
if (audio._loaded) {
audio.stop();
audio.setCurrentTime(0);
audio.play();
return;
}
audio.src = this._clip;
audio.once('load', function () {
audio.setLoop(loop);
audio.setVolume(volume);
audio.play();
});
audio.preload();
},
/**
* !#en Stops the clip.
* !#zh 停止当前音频剪辑。
* @method stop
*/
stop: function () {
if (this.audio) {
this.audio.stop();
}
},
/**
* !#en Pause the clip.
* !#zh 暂停当前音频剪辑。
* @method pause
*/
pause: function () {
if (this.audio) {
this.audio.pause();
}
},
/**
* !#en Resume the clip.
* !#zh 恢复播放。
* @method resume
*/
resume: function () {
if (this.audio) {
this.audio.resume();
}
},
/**
* !#en Rewind playing music.
* !#zh 从头开始播放。
* @method rewind
*/
rewind: function(){
if (this.audio) {
this.audio.setCurrentTime(0);
}
},
/**
* !#en Get current time
* !#zh 获取当前的播放时间
* @method getCurrentTime
*/
getCurrentTime: function () {
var time = 0;
if (this.audio) {
time = this.audio.getCurrentTime();
}
return time;
},
/**
* !#en Set current time
* !#zh 设置当前的播放时间
* @method setCurrentTime
* @param {Number} time
*/
setCurrentTime: function (time) {
var audio = this.audio;
if (!audio) return time;
if (!audio._loaded) {
audio.once('load', function () {
audio.setCurrentTime(time);
});
return time;
}
audio.setCurrentTime(time);
return time;
},
/**
* !#en Get audio duration
* !#zh 获取当前音频的长度
* @method getDuration
*/
getDuration: function () {
var time = 0;
if (this.audio) {
time = this.audio.getDuration();
}
return time;
}
});
cc.AudioSource = module.exports = AudioSource;