Public 成员函数 - 《Cocos2dx 3.0 api 文档帮助手册教程》

详细描述
构造及析构函数说明
成员函数说明

cocos2d-x 3.0

- 首页 - 相关页面 - 模块 - 命名空间 - 类 - 文件 -

)
- 类列表 - 类索引 - 类继承关系 - 类成员

全部) 类) 命名空间) 文件) 函数) 变量) 类型定义) 枚举) 枚举值) 属性) 友元) 宏定义) 组) 页)

Public 成员函数 | 静态 Public 成员函数 | Protected 成员函数 | 所有成员列表

SimpleAudioEngine类参考

提供播放音效和背景音乐的一系列接口更多…

#include

类 SimpleAudioEngine 继承关系图:

Public 成员函数 - 图3

## Public 成员函数
virtual void	preloadBackgroundMusic (const char pszFilePath)
	预加载背景音乐更多…

virtual void	playBackgroundMusic (const char pszFilePath, bool bLoop=false)
	播放背景音乐更多…

virtual void	stopBackgroundMusic (bool bReleaseData=false)
	停止播放背景音乐更多…

virtual void	pauseBackgroundMusic ()
	暂停播放背景音乐 pauseMusic pauseMusic 更多…

virtual void	resumeBackgroundMusic ()
	恢复播放背景音乐 resumeMusic resumeMusic 更多…

virtual void	rewindBackgroundMusic ()
	把背景音乐倒过来放 rewindMusic rewindMusic 更多…

virtual bool	willPlayBackgroundMusic ()
	是否会播放背景音乐更多…

virtual bool	isBackgroundMusicPlaying ()
	背景音乐是否在播放更多…

virtual float	getBackgroundMusicVolume ()
	获取背景音乐的音量，音量的值的范围为0.0到1.0 getMusicVolume getMusicVolume 更多…

virtual void	setBackgroundMusicVolume (float volume)
	设置背景音乐音量更多…

virtual float	getEffectsVolume ()
	获取音效的音量大小,音量大小范围为0.0到1.0 更多…

virtual void	setEffectsVolume (float volume)
	设置音效的音量大小更多…

virtual unsigned int	playEffect (const char pszFilePath, bool bLoop=false, float pitch=1.0f, float pan=0.0f, float gain=1.0f)
	播放音效更多…

virtual void	pauseEffect (unsigned int nSoundId)
	暂停播放音效更多…

virtual void	pauseAllEffects ()
	暂停所有播放的音效更多…

virtual void	resumeEffect (unsigned int nSoundId)
	恢复暂停播放的音效更多…

virtual void	resumeAllEffects ()
	恢复所有暂停的音效更多…

virtual void	stopEffect (unsigned int nSoundId)
	停止播放音效更多…

virtual void	stopAllEffects ()
	停止所有播放的音效更多…

virtual void	preloadEffect (const char pszFilePath)
	加载压缩过的音效文件更多…

virtual void	unloadEffect (const char *pszFilePath)
	卸载预加载到内存中的音效文件更多…

## 静态 Public 成员函数
static SimpleAudioEngine	getInstance ()
	获取共享的实例，如果是第一次调用，会自动创建一个实例更多…

static SimpleAudioEngine	sharedEngine ()
	NA NA 更多…

static void	end ()
	释放音效引擎实例更多…

## Protected 成员函数
	SimpleAudioEngine ()

virtual	~SimpleAudioEngine ()

详细描述

提供播放音效和背景音乐的一系列接口

注解
当不再使用音效系统时，确保调用了SimpleAudioEngine::end()来释放所有分配出来的资源

构造及析构函数说明

SimpleAudioEngine

(

)

protected

virtual ~SimpleAudioEngine

(

)

protectedvirtual

成员函数说明

static void end

(

)

static

释放音效引擎实例

警告
在游戏退出时需要调用这个方法，不然的话会导致内存泄漏

virtual float getBackgroundMusicVolume

(

)

virtual

获取背景音乐的音量，音量的值的范围为0.0到1.0 getMusicVolume getMusicVolume

virtual float getEffectsVolume

(

)

virtual

获取音效的音量大小,音量大小范围为0.0到1.0

static SimpleAudioEngine* getInstance

(

)

static

获取共享的实例，如果是第一次调用，会自动创建一个实例

virtual bool isBackgroundMusicPlaying

(

)

virtual

背景音乐是否在播放

返回
正在播放返回true,否则返回false isMusicPlaying isMusicPlaying

virtual void pauseAllEffects

(

)

virtual

暂停所有播放的音效

virtual void pauseBackgroundMusic

(

)

virtual

暂停播放背景音乐 pauseMusic pauseMusic

virtual void pauseEffect

(

unsigned int

nSoundId

)

virtual

暂停播放音效

参数
nSoundIdplayEffect返回的资源id

virtual void playBackgroundMusic	(	const char *	pszFilePath,
		bool	bLoop = `false`
	)

virtual

播放背景音乐

参数
pszFilePath背景音乐的文件路径活T_SoundResInfo中的FileName字段 bLoop背景音乐是否循环播放 playMusic playMusic

virtual unsigned int playEffect	(	const char *	pszFilePath,
		bool	bLoop = `false`,
		float	pitch = `1.0f`,
		float	pan = `0.0f`,
		float	gain = `1.0f`
	)

virtual

播放音效

参数
pszFilePath音效文件的路径 bLoop是否循环播放,默认为false,不循环 pitch频率，正常情况下为1.0,在播放时也可以改变该值 pan声道，范围为-1到1，为-1时表示只有左声道，为1时表示只有右声道 gain音量增益, 范围为0到1，默认值为1

返回
OpenAL的资源id

注解
现在还不能完全支持所有参数，限制的功能如下：
- 在Samsung Galaxy S2上如果启用了OpenSL那么pitch参数无效；
- 在emscrippten, win32, marmalade上pitch/pan/gain参数无效

virtual void preloadBackgroundMusic

(

const char *

pszFilePath

)

virtual

预加载背景音乐

参数
pszFilePath背景音乐的文件路径 preloadMusic preloadMusic

virtual void preloadEffect

(

const char *

pszFilePath

)

virtual

加载压缩过的音效文件

压缩过的音频文件会解码成wave文件，并且写入SimpleAudioEngine的内存中

参数
pszFilePath音效文件路径

virtual void resumeAllEffects

(

)

virtual

恢复所有暂停的音效

virtual void resumeBackgroundMusic

(

)

virtual

恢复播放背景音乐 resumeMusic resumeMusic

virtual void resumeEffect

(

unsigned int

nSoundId

)

virtual

恢复暂停播放的音效

参数
nSoundIdplayEffect返回的资源id

virtual void rewindBackgroundMusic

(

)

virtual

把背景音乐倒过来放 rewindMusic rewindMusic

virtual void setBackgroundMusicVolume

(

float

volume

)

virtual

设置背景音乐音量

参数
volume背景音乐音量大小，范围必须为0.0到1.0之间 setMusicVolume setMusicVolume

virtual void setEffectsVolume

(

float

volume

)

virtual

设置音效的音量大小

参数
volume音效的音量大小，范围为0.0到1.0

static SimpleAudioEngine* sharedEngine

(

)

inlinestatic

NA NA

virtual void stopAllEffects

(

)

virtual

停止所有播放的音效

virtual void stopBackgroundMusic ( bool bReleaseData = false )

virtual

停止播放背景音乐

参数
bReleaseData是否释放背景音乐的数据，默认值为false stopMusic stopMusic

virtual void stopEffect

(

unsigned int

nSoundId

)

virtual

停止播放音效

参数
nSoundIdplayEffect返回的资源id

virtual void unloadEffect

(

const char *

pszFilePath

)

virtual

卸载预加载到内存中的音效文件

参数
pszFilePath音效文件的路径

virtual bool willPlayBackgroundMusic

(

)

virtual

是否会播放背景音乐

返回
如果背景音乐会被播放返回true,否则返回false. willPlayMusic willPlayMusic

该类的文档由以下文件生成:

/Users/zeroyang/Documents/github/cocos2d-x/cocos/audio/include/SimpleAudioEngine.h

CocosDenshion
SimpleAudioEngine
生成于 2014年五月 29日星期四 09:41:58 , 为 cocos2d-x使用 1.8.6