mirror of https://github.com/axmolengine/axmol.git
133 lines
3.9 KiB
C++
133 lines
3.9 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2013-2017 Chukong Technologies Inc.
|
|
|
|
https://axis-project.github.io/
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
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.
|
|
****************************************************************************/
|
|
|
|
#ifndef __CC_EXTENTIONS_CCCOMAUDIO_H__
|
|
#define __CC_EXTENTIONS_CCCOMAUDIO_H__
|
|
|
|
#include "CCComBase.h"
|
|
#include "base/CCProtocols.h"
|
|
#include "2d/CCComponent.h"
|
|
#include "CocosStudioExport.h"
|
|
|
|
namespace cocostudio
|
|
{
|
|
|
|
class CCS_DLL ComAudio : public axis::Component, public axis::PlayableProtocol
|
|
{
|
|
DECLARE_CLASS_COMPONENT_INFO
|
|
public:
|
|
const static std::string COMPONENT_NAME;
|
|
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
ComAudio();
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~ComAudio();
|
|
|
|
public:
|
|
static ComAudio* create();
|
|
|
|
virtual bool init() override;
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onEnter() override;
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onExit() override;
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onAdd() override;
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onRemove() override;
|
|
|
|
virtual bool serialize(void* r) override;
|
|
|
|
public:
|
|
/**
|
|
* @lua endToLua
|
|
*/
|
|
void end();
|
|
void preloadBackgroundMusic(const char* pszFilePath);
|
|
void playBackgroundMusic(const char* pszFilePath, bool bLoop);
|
|
void playBackgroundMusic(const char* pszFilePath);
|
|
void playBackgroundMusic();
|
|
void stopBackgroundMusic(bool bReleaseData);
|
|
void stopBackgroundMusic();
|
|
void pauseBackgroundMusic();
|
|
void resumeBackgroundMusic();
|
|
void rewindBackgroundMusic();
|
|
bool willPlayBackgroundMusic();
|
|
bool isBackgroundMusicPlaying();
|
|
float getBackgroundMusicVolume();
|
|
void setBackgroundMusicVolume(float volume);
|
|
float getEffectsVolume();
|
|
void setEffectsVolume(float volume);
|
|
unsigned int playEffect(const char* pszFilePath, bool bLoop);
|
|
unsigned int playEffect(const char* pszFilePath);
|
|
unsigned int playEffect();
|
|
void pauseEffect(unsigned int nSoundId);
|
|
void pauseAllEffects();
|
|
void resumeEffect(unsigned int nSoundId);
|
|
void resumeAllEffects();
|
|
void stopEffect(unsigned int nSoundId);
|
|
void stopAllEffects();
|
|
void preloadEffect(const char* pszFilePath);
|
|
void unloadEffect(const char* pszFilePath);
|
|
void setFile(const char* pszFilePath);
|
|
const char* getFile();
|
|
void setLoop(bool bLoop);
|
|
bool isLoop();
|
|
|
|
/// @{
|
|
/// @name implement Playable Protocol
|
|
// play the effect sound path in _filePath
|
|
virtual void start() override;
|
|
// stop the effect sound which started with latest start()
|
|
virtual void stop() override;
|
|
/// @} end of PlayableProtocol
|
|
|
|
private:
|
|
std::string _filePath;
|
|
bool _loop;
|
|
|
|
unsigned int _startedSoundId; // !playing sound id from start(), not playEffect
|
|
};
|
|
|
|
} // namespace cocostudio
|
|
|
|
#endif // __CC_EXTENTIONS_CCCOMAUDIO_H__
|