本文透過一個完整範例,示範如何在 cocos2d-x 3.x 中使用 SimpleAudioEngine 來播放背景音樂與音效,並用滑桿即時調整音量、音高、左右聲道與增益。
首先是標頭檔,定義場景與各控制項:
#include "cocos2d.h"
#include "SimpleAudioEngine.h"
#include "extensions/GUI/CCControlExtension/CCControlSlider.h"
USING_NS_CC;
using namespace CocosDenshion;
using namespace extension;
class AudioSlider;
class HelloWorld : public Layer{
private:
unsigned int _soundId; // 音效的 id
AudioSlider *_sliderMusicVolume; // 背景音樂音量滑桿
AudioSlider *_sliderEffectsVolume; // 音效音量滑桿
AudioSlider *_sliderPitch; // 音高滑桿
AudioSlider *_sliderPan; // 聲道滑桿
AudioSlider *_sliderGain; // 增益滑桿
public:
static Scene* createScene();
virtual bool init();
void musicValueChanged(Ref* pSender,Control::EventType controlEvent);
void effectsValueChanged(Ref* pSender,Control::EventType controlEvent);
void menuCloseCallback(cocos2d::Ref* pSender);
CREATE_FUNC(HelloWorld);
};
實作檔則依不同平台選擇對應格式的音樂與音效檔案,並建立按鈕、滑桿等 UI:
#include "HelloWorldScene.h"
// 依不同平台選擇音效格式
#if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID)
#define EFFECT_FILE "effect2.ogg"
#elif( CC_TARGET_PLATFORM == CC_PLATFORM_MARMALADE)
#define EFFECT_FILE "effect1.raw"
#else
#define EFFECT_FILE "effect1.wav"
#endif
// 依不同平台選擇背景音樂格式
#if (CC_TARGET_PLATFORM == CC_PLATFORM_WIN32)
#define MUSIC_FILE "music.mid"
#elif (CC_TARGET_PLATFORM == CC_PLATFORM_BLACKBERRY || CC_TARGET_PLATFORM == CC_PLATFORM_LINUX )
#define MUSIC_FILE "background.ogg"
#else
#define MUSIC_FILE "background.mp3"
#endif
class Button : public Node{
public:
static Button *createWithSprite(const char *filePath){
auto b = new Button();
if(b && !b->initSpriteButton(filePath)){ delete b; b = NULL; }
return b;
}
static Button *createWithText(const char *text){
auto b = new Button();
if(b && !b->initTextButton(text)){ delete b; b = NULL; }
return b;
}
~Button(){ }
void onTriggered(const std::function &onTriggered){ _onTriggered = onTriggered; }
private:
Button():_child(NULL){
auto listener = EventListenerTouchOneByOne::create();
listener->setSwallowTouches(true);
listener->onTouchBegan = [=](Touch* touch,Event *event){
const bool hits = touchHits(touch);
if(hits) scaleButtonTo(0.9f);
return hits;
};
listener->onTouchEnded = [=](Touch *touch,Event *event){
const bool hits = touchHits(touch);
if(hits && _onTriggered) _onTriggered();
scaleButtonTo(1);
};
listener->onTouchCancelled = [=](Touch *touch,Event *event){ scaleButtonTo(1); };
_eventDispatcher->addEventListenerWithSceneGraphPriority(listener,this);
}
bool initSpriteButton(const char *filePath){
_child = Sprite::create(filePath);
addChild(_child);
return true;
}
bool initTextButton(const char *text){
_child = Label::createWithSystemFont(text,"Arial", 32);
addChild(_child);
return true;
}
bool touchHits(Touch *touch){
const Rect area(0,0,_child->getContentSize().width,_child->getContentSize().height);
return area.containsPoint(_child->convertToNodeSpace(touch->getLocation()));
}
void scaleButtonTo(float scale){
auto action = ScaleTo::create(0.1f, scale);
action->setTag(900);
stopActionByTag(900);
runAction(action);
}
Node *_child;
std::function _onTriggered;
};
// 自定義音量調節類
class AudioSlider : public Node{
public:
static AudioSlider *create(){
auto ret = new AudioSlider();
if(ret && !ret->init()){ delete ret; ret = NULL; }
return ret;
}
float getValue()const{ return _slider->getValue(); }
void setValue(float minValue,float maxValue,float value){
_slider->setMinimumValue(minValue);
_slider->setMaximumValue(maxValue);
_slider->setValue(value);
char buffer[32];
sprintf(buffer,"%.2f",minValue);
_lblMinValue = Label::createWithSystemFont(buffer,"Arial",18);
addChild(_lblMinValue);
sprintf(buffer,"%.2f",maxValue);
_lblMaxValue = Label::createWithSystemFont(buffer,"Arial",18);
addChild(_lblMaxValue);
}
void setSliderPosition(float x,float y){
Size visibleSize = Director::getInstance()->getVisibleSize();
_slider->setPosition(visibleSize.width * x,visibleSize.height * y);
_lblMinValue->setPosition(visibleSize.width * (x - 0.1),visibleSize.height * (y + 0.05));
_lblMaxValue->setPosition(visibleSize.width * (x + 0.1),visibleSize.height * (y + 0.05));
}
ControlSlider* getSlider(){ return _slider; }
private:
bool init(){
_slider = ControlSlider::create("sliderTrack.png","sliderProgress.png","sliderThumb.png");
addChild(_slider);
return true;
}
ControlSlider *_slider; // 調整滑桿
Label *_lblMinValue; // 最小值標籤
Label *_lblMaxValue; // 最大值標籤
};
Scene* HelloWorld::createScene(){
auto scene = Scene::create();
auto layer = HelloWorld::create();
scene->addChild(layer);
return scene;
}
bool HelloWorld::init(){
if ( !Layer::init() ){ return false; }
Size visibleSize = Director::getInstance()->getVisibleSize();
Vec2 origin = Director::getInstance()->getVisibleOrigin();
auto closeItem = MenuItemImage::create( "CloseNormal.png", "CloseSelected.png", CC_CALLBACK_1(HelloWorld::menuCloseCallback, this));
closeItem->setPosition(Vec2(origin.x + visibleSize.width - closeItem->getContentSize().width/2 , origin.y + closeItem->getContentSize().height/2));
auto menu = Menu::create(closeItem, NULL);
menu->setPosition(Vec2::ZERO);
this->addChild(menu, 1);
// 預加載音樂和音效
SimpleAudioEngine::getInstance()->preloadBackgroundMusic(MUSIC_FILE);
SimpleAudioEngine::getInstance()->preloadEffect(EFFECT_FILE);
// 背景音樂控制
auto lbMusic = Label::createWithSystemFont("背景音樂控制","Arial",32);
lbMusic->setPosition(visibleSize.width * 0.25,visibleSize.height * 0.9);
this->addChild(lbMusic);
auto playMusic = Button::createWithText("播放");
playMusic->onTriggered([]{ SimpleAudioEngine::getInstance()->playBackgroundMusic(MUSIC_FILE); });
playMusic->setPosition(visibleSize.width * 0.1,visibleSize.height * 0.8);
this->addChild(playMusic);
auto stopMusic = Button::createWithText("停止");
stopMusic->onTriggered([]{ SimpleAudioEngine::getInstance()->stopBackgroundMusic(); });
stopMusic->setPosition(visibleSize.width * 0.25,visibleSize.height * 0.8);
this->addChild(stopMusic);
auto rewinMusic = Button::createWithText("回放");
rewinMusic->onTriggered([]{ SimpleAudioEngine::getInstance()->rewindBackgroundMusic(); });
rewinMusic->setPosition(visibleSize.width * 0.40,visibleSize.height * 0.8);
this->addChild(rewinMusic);
auto pauseMusic = Button::createWithText("暫停");
pauseMusic->onTriggered([]{ SimpleAudioEngine::getInstance()->pauseBackgroundMusic(); });
pauseMusic->setPosition(visibleSize.width * 0.10,visibleSize.height * 0.65);
this->addChild(pauseMusic);
auto resumeMusic = Button::createWithText("繼續");
resumeMusic->onTriggered([]{ SimpleAudioEngine::getInstance()->resumeBackgroundMusic(); });
resumeMusic->setPosition(visibleSize.width * 0.25,visibleSize.height * 0.65);
this->addChild(resumeMusic);
// 音效控制
auto lblSound = Label::createWithSystemFont("音效控制","Arial",32);
lblSound->setPosition(visibleSize.width * 0.75,visibleSize.height * 0.9);
this->addChild(lblSound);
auto playEffect = Button::createWithText("播放");
playEffect->onTriggered([this]{
const float pitch = _sliderPitch->getValue();
const float pan = _sliderPan->getValue();
const float gain = _sliderGain->getValue();
_soundId = SimpleAudioEngine::getInstance()->playEffect(EFFECT_FILE,false,pitch,pan,gain);
});
playEffect->setPosition(visibleSize.width * 0.6,visibleSize.height * 0.8);
this->addChild(playEffect);
auto pauseEffect = Button::createWithText("暫停");
pauseEffect->onTriggered([this]{ SimpleAudioEngine::getInstance()->pauseEffect(_soundId); });
pauseEffect->setPosition(visibleSize.width * 0.75,visibleSize.height * 0.8);
this->addChild(pauseEffect);
auto resumeEffect = Button::createWithText("繼續");
resumeEffect->onTriggered([this]{ SimpleAudioEngine::getInstance()->resumeEffect(_soundId); });
resumeEffect->setPosition(visibleSize.width * 0.9,visibleSize.height * 0.8);
this->addChild(resumeEffect);
auto stopEffect = Button::createWithText("停止");
stopEffect->onTriggered([this]{ SimpleAudioEngine::getInstance()->stopEffect(_soundId); });
stopEffect->setPosition(visibleSize.width * 0.6,visibleSize.height * 0.7);
this->addChild(stopEffect);
auto playEffectInLoop = Button::createWithText("循環播放");
playEffectInLoop->onTriggered([this]{
const float pitch = _sliderPitch->getValue();
const float pan = _sliderPan->getValue();
const float gain = _sliderGain->getValue();
_soundId = SimpleAudioEngine::getInstance()->playEffect(EFFECT_FILE,true,pitch,pan,gain);
});
playEffectInLoop->setPosition(visibleSize.width * 0.75,visibleSize.height * 0.70);
this->addChild(playEffectInLoop);
auto pauseAllEffect = Button::createWithText("暫停所有");
pauseAllEffect->onTriggered([this]{ SimpleAudioEngine::getInstance()->pauseAllEffects(); });
pauseAllEffect->setPosition(visibleSize.width * 0.55,visibleSize.height * 0.60);
this->addChild(pauseAllEffect);
auto resumeAllEffect = Button::createWithText("繼續所有");
resumeAllEffect->onTriggered([this]{ SimpleAudioEngine::getInstance()->resumeAllEffects(); });
resumeAllEffect->setPosition(visibleSize.width * 0.75,visibleSize.height * 0.60);
this->addChild(resumeAllEffect);
auto stopAllEffect = Button::createWithText("停止所有");
stopAllEffect->onTriggered([this]{ SimpleAudioEngine::getInstance()->stopAllEffects(); });
stopAllEffect->setPosition(visibleSize.width * 0.92,visibleSize.height * 0.60);
this->addChild(stopAllEffect);
// 音量調整滑桿
auto lblMusicVolume = Label::createWithSystemFont("音量","Arial",24);
lblMusicVolume->setPosition(visibleSize.width * 0.08,visibleSize.height * 0.45);
this->addChild(lblMusicVolume);
_sliderMusicVolume = AudioSlider::create();
_sliderMusicVolume->setValue(0.00f,1.00f, 1.0f);
_sliderMusicVolume->setSliderPosition(0.28,0.45);
_sliderMusicVolume->getSlider()->addTargetWithActionForControlEvents(this, cccontrol_selector(HelloWorld::musicValueChanged),Control::EventType::VALUE_CHANGED);
this->addChild(_sliderMusicVolume);
auto lblEffectsVolume = Label::createWithSystemFont("音效","Arial", 24);
lblEffectsVolume->setPosition(visibleSize.width * 0.60,visibleSize.height * 0.45);
this->addChild(lblEffectsVolume);
_sliderEffectsVolume = AudioSlider::create();
_sliderEffectsVolume->setValue(0.00f, 1.00f, 1.0f);
_sliderEffectsVolume->setSliderPosition(0.80,0.45);
_sliderEffectsVolume->getSlider()->addTargetWithActionForControlEvents(this, cccontrol_selector(HelloWorld::effectsValueChanged),Control::EventType::VALUE_CHANGED);
this->addChild(_sliderEffectsVolume);
// 高音、聲道、增益滑桿
auto lblPltich = Label::createWithSystemFont("高音","Arial",24);
lblPltich->setPosition(visibleSize.width * 0.60,visibleSize.height * 0.35);
this->addChild(lblPltich);
_sliderPitch = AudioSlider::create();
_sliderPitch->setValue(-0.50f, 2.00f, 1.0f);
_sliderPitch->setSliderPosition(0.85, 0.35);
this->addChild(_sliderPitch);
auto lblPan = Label::createWithSystemFont("立體效果","Arial", 24);
lblPan->setPosition(visibleSize.width * 0.60,visibleSize.height * 0.25);
this->addChild(lblPan);
_sliderPan = AudioSlider::create();
_sliderPan->setValue(-1.00f, 1.00f, 0.0f);
_sliderPan->setSliderPosition(0.80, 0.25);
this->addChild(_sliderPan);
auto lblGain = Label::createWithSystemFont("音量","Arial",24);
lblGain->setPosition(visibleSize.width * 0.60,visibleSize.height * 0.15);
this->addChild(lblGain);
_sliderGain = AudioSlider::create();
_sliderGain->setValue(0.00f, 1.00f, 1.0f);
_sliderGain->setSliderPosition(0.80, 0.15);
this->addChild(_sliderGain);
return true;
}
void HelloWorld::musicValueChanged(Ref *pSender, Control::EventType controlEvent){
ControlSlider* pSlider = dynamic_cast(pSender);
const float musicVolume = pSlider->getValue();
SimpleAudioEngine::getInstance()->setBackgroundMusicVolume(musicVolume);
}
void HelloWorld::effectsValueChanged(Ref *pSender, Control::EventType controlEvent){
ControlSlider* pSlider = dynamic_cast(pSender);
const float effectVolume = pSlider->getValue();
SimpleAudioEngine::getInstance()->setEffectsVolume(effectVolume);
}
void HelloWorld::menuCloseCallback(Ref* pSender) {
#if (CC_TARGET_PLATFORM == CC_PLATFORM_WP8) || (CC_TARGET_PLATFORM == CC_PLATFORM_WINRT)
MessageBox("You pressed the close button. Windows Store Apps do not implement a close button.","Alert");
return;
#endif
Director::getInstance()->end();
#if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS)
exit(0);
#endif
}
範例執行後的效果如下: