docs: 添加 Audio 模块和 Components 模块 API 文档

- 新增 Audio 模块文档 (54 个文件)
  - AudioSystem 单例类及 20 个方法页
  - AudioMixer 混音器类及 11 个方法页
  - IAudioBackend、IAudioEffect 接口
  - FFTFilter、Reverbation、Equalizer、HRTF 效果类
  - WASAPIBackend Windows 后端
  - AudioConfig、Audio3DParams 等结构体
  - 9 个枚举类型文档
- 新增 Components 模块文档 (3 个文件)
  - AudioSourceComponent 音频源组件
  - AudioListenerComponent 音频监听器组件
- 更新 docs/api/main.md 添加模块导航
This commit is contained in:
2026-03-22 01:56:16 +08:00
parent 6e5ed41fbf
commit 161a0896d5
58 changed files with 1990 additions and 0 deletions

View File

@@ -0,0 +1,39 @@
# AudioSystem::GetStats
获取音频系统统计信息。
```cpp
const Stats& GetStats() const;
```
返回包含音频系统运行时统计信息的结构体,包括活跃源数量、总源数量、内存使用量和 CPU 使用率。
**返回:** `const Stats&` - 统计信息结构体引用
**Stats 结构体:**
| 成员 | 类型 | 描述 |
|------|------|------|
| `activeSources` | `uint32_t` | 当前正在播放的音频源数量 |
| `totalSources` | `uint32_t` | 注册的音频源总数 |
| `memoryUsage` | `uint64_t` | 音频系统内存使用量(字节) |
| `cpuUsage` | `float` | CPU 使用率估算值 |
**示例:**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
using namespace XCEngine::Audio;
void PrintAudioStats() {
const auto& stats = AudioSystem::Get().GetStats();
printf("Active sources: %u / %u\n", stats.activeSources, stats.totalSources);
printf("Memory usage: %.2f MB\n", stats.memoryUsage / (1024.0 * 1024.0));
printf("CPU usage: %.1f%%\n", stats.cpuUsage * 100.0f);
}
```
## 相关文档
- [AudioSystem 总览](audio-system.md)