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,46 @@
# Audio3DParams
**命名空间**: `XCEngine::Audio`
**类型**: `struct`
**头文件**: `XCEngine/Audio/AudioTypes.h`
**描述**: 3D 空间化音频参数。
## 结构体成员
| 成员 | 类型 | 描述 | 默认值 |
|------|------|------|--------|
| `dopplerLevel` | `float` | 多普勒效应等级0.0=禁用1.0=正常 | `1.0f` |
| `speedOfSound` | `float` | 声速(米/秒) | `343.0f` |
| `minDistance` | `float` | 最小衰减距离(米) | `1.0f` |
| `maxDistance` | `float` | 最大衰减距离(米) | `500.0f` |
| `panLevel` | `float` | 声像等级0.0=无 3D1.0=完全 3D | `1.0f` |
| `spread` | `float` | 声源展开角度(度) | `0.0f` |
| `reverbZoneMix` | `float` | 混响区域混合比例 | `1.0f` |
## 使用示例
```cpp
#include <XCEngine/Audio/AudioTypes.h>
using namespace XCEngine::Audio;
Audio3DParams CreateOutdoorParams() {
Audio3DParams params;
params.dopplerLevel = 1.0f;
params.speedOfSound = 343.0f;
params.minDistance = 1.0f;
params.maxDistance = 1000.0f;
params.panLevel = 1.0f;
params.spread = 0.0f;
params.reverbZoneMix = 0.5f;
return params;
}
```
## 相关文档
- [Audio 模块总览](../audio.md) - Audio 模块总览
- [AudioMixer](../audio-mixer/audio-mixer.md) - 音频混音器