Kiwano Engine  v1.2.x
kiwano::audio::SoundPlayer类 参考

音频播放器 更多...

#include <SoundPlayer.h>

类 kiwano::audio::SoundPlayer 继承关系图:
kiwano::audio::SoundPlayer 的协作图:

Public 成员函数

size_t Load (const String &file_path)
 加载本地音频文件 更多...
 
size_t Load (const Resource &res)
 加载音频资源 更多...
 
void Play (size_t id, int loop_count=0)
 播放音频 更多...
 
void Pause (size_t id)
 暂停音频 更多...
 
void Resume (size_t id)
 继续播放音频 更多...
 
void Stop (size_t id)
 停止音频 更多...
 
bool IsPlaying (size_t id)
 获取音频播放状态 更多...
 
float GetVolume () const
 获取音量
 
void SetVolume (float volume)
 设置音量 更多...
 
size_t GetId (const String &file_path) const
 获取本地音频文件id 更多...
 
size_t GetId (const Resource &res) const
 获取音频资源id 更多...
 
SoundPtr GetSound (size_t id) const
 获取音乐对象 更多...
 
void PauseAll ()
 暂停所有音频
 
void ResumeAll ()
 继续播放所有音频
 
void StopAll ()
 停止所有音频
 
void ClearCache ()
 清除缓存
 
- Public 成员函数 继承自 kiwano::ObjectBase
 ObjectBase ()
 构造基础对象
 
void SetName (const String &name)
 设置对象名
 
String GetName () const
 获取对象名
 
bool IsName (const String &name) const
 判断对象的名称是否相同 更多...
 
void * GetUserData () const
 获取用户数据
 
void SetUserData (void *data)
 设置用户数据
 
uint64_t GetObjectID () const
 获取对象ID
 
void DoSerialize (Serializer *serializer) const override
 序列化
 
void DoDeserialize (Deserializer *deserializer) override
 反序列化
 
virtual bool IsValid () const
 判断对象是否有效
 
ObjectStatusGetStatus () const
 获取对象状态
 
void SetStatus (const ObjectStatus &status)
 设置对象状态
 
void Fail (const String &msg, int code=ObjectStatus::fail)
 将对象标记为失败状态
 
void ClearStatus ()
 清除对象状态
 
- Public 成员函数 继承自 kiwano::RefObject
void Retain ()
 增加引用计数
 
void Release ()
 减少引用计数
 
uint32_t GetRefCount () const
 获取引用计数
 
- Public 成员函数 继承自 kiwano::Serializable
Vector< uint8_t > Serialize () const
 序列化为字节串
 
void Deserialize (const Vector< uint8_t > &data)
 从字节串反序列化
 

额外继承的成员函数

- 静态 Public 成员函数 继承自 kiwano::ObjectBase
static void SetObjectPolicy (const ObjectPolicyFunc &policy)
 设置对象处理策略
 
static bool IsTracingLeaks ()
 是否启用了内存泄漏追踪
 
static void StartTracingLeaks ()
 开始追踪内存泄漏
 
static void StopTracingLeaks ()
 停止追踪内存泄漏
 
static void DumpTracingObjects ()
 打印所有追踪中的对象信息
 
static Vector< ObjectBase * > & GetTracingObjects ()
 获取所有追踪中的对象
 
- 静态 Public 成员函数 继承自 kiwano::RefObject
static void * operator new (size_t size)
 
static void operator delete (void *ptr)
 
static void * operator new (size_t size, std::nothrow_t const &) noexcept
 
static void operator delete (void *ptr, std::nothrow_t const &) noexcept
 
static void * operator new (size_t size, void *ptr) noexcept
 
static void operator delete (void *ptr, void *place) noexcept
 

详细描述

音频播放器

成员函数说明

size_t kiwano::audio::SoundPlayer::GetId ( const String &  file_path) const

获取本地音频文件id

参数
file_path本地音频文件路径
返回
音频标识符
size_t kiwano::audio::SoundPlayer::GetId ( const Resource res) const

获取音频资源id

参数
res音频资源
返回
音频标识符
SoundPtr kiwano::audio::SoundPlayer::GetSound ( size_t  id) const

获取音乐对象

参数
id音频标识符
bool kiwano::audio::SoundPlayer::IsPlaying ( size_t  id)

获取音频播放状态

参数
id音频标识符
size_t kiwano::audio::SoundPlayer::Load ( const String &  file_path)

加载本地音频文件

参数
file_path本地音频文件路径
返回
音频标识符
size_t kiwano::audio::SoundPlayer::Load ( const Resource res)

加载音频资源

参数
res音频资源
返回
音频标识符
void kiwano::audio::SoundPlayer::Pause ( size_t  id)

暂停音频

参数
id音频标识符
void kiwano::audio::SoundPlayer::Play ( size_t  id,
int  loop_count = 0 
)

播放音频

参数
id音频标识符
loop_count播放循环次数,设置 -1 为循环播放
void kiwano::audio::SoundPlayer::Resume ( size_t  id)

继续播放音频

参数
id音频标识符
void kiwano::audio::SoundPlayer::SetVolume ( float  volume)

设置音量

参数
volume音量大小,1.0 为原始音量, 大于 1 为放大音量, 0 为最小音量
void kiwano::audio::SoundPlayer::Stop ( size_t  id)

停止音频

参数
id音频标识符