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

音频对象 更多...

#include <Sound.h>

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

Public 成员函数

 Sound (const String &file_path)
 创建音频对象 更多...
 
 Sound (const Resource &res)
 创建音频对象 更多...
 
bool Load (const String &file_path)
 打开本地音频文件 更多...
 
bool Load (const Resource &res)
 打开音频资源 更多...
 
bool IsValid () const
 是否有效
 
void Play (int loop_count=0)
 播放 更多...
 
void Pause ()
 暂停
 
void Resume ()
 继续
 
void Stop ()
 停止
 
void Close ()
 关闭并销毁资源
 
bool IsPlaying () const
 是否正在播放
 
float GetVolume () const
 获取音量
 
void SetVolume (float volume)
 设置音量 更多...
 
- 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
 反序列化
 
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)
 从字节串反序列化
 

友元

class AudioModule
 

额外继承的成员函数

- 静态 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
 

详细描述

音频对象

构造及析构函数说明

kiwano::audio::Sound::Sound ( const String &  file_path)

创建音频对象

参数
res本地音频文件路径
kiwano::audio::Sound::Sound ( const Resource res)

创建音频对象

参数
res音频资源

成员函数说明

bool kiwano::audio::Sound::Load ( const String &  file_path)

打开本地音频文件

参数
res本地音频文件路径
bool kiwano::audio::Sound::Load ( const Resource res)

打开音频资源

参数
res音频资源
void kiwano::audio::Sound::Play ( int  loop_count = 0)

播放

参数
loop_count播放循环次数,设置 -1 为循环播放
void kiwano::audio::Sound::SetVolume ( float  volume)

设置音量

参数
volume音量大小,1.0 为原始音量, 大于 1 为放大音量, 0 为最小音量