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:
42
docs/api/audio/hrtf-params/hrtf-params.md
Normal file
42
docs/api/audio/hrtf-params/hrtf-params.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# HRTFParams
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
**描述**: HRTF 空间化参数。
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `azimuth` | `float` | 方位角(度) | `0.0f` |
|
||||
| `elevation` | `float` | 仰角(度) | `0.0f` |
|
||||
| `interauralTimeDelay` | `float` | 耳间时间差(秒) | `0.0f` |
|
||||
| `interauralLevelDifference` | `float` | 耳间电平差 | `0.0f` |
|
||||
| `headShadowing` | `float` | 头部阴影系数 | `0.0f` |
|
||||
| `pinnaCues` | `float` | 耳廓线索系数 | `0.0f` |
|
||||
| `torsoShoulderRotation` | `float` | 躯干/肩部旋转角度 | `0.0f` |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
using namespace XCEngine::Audio;
|
||||
|
||||
void ProcessWithHRTFParams(HRTF* hrtf) {
|
||||
HRTFParams params;
|
||||
params.azimuth = 45.0f;
|
||||
params.elevation = 0.0f;
|
||||
params.interauralTimeDelay = 0.0006f;
|
||||
params.interauralLevelDifference = 3.0f;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
- [HRTF](../hrtf/hrtf.md) - HRTF 类
|
||||
Reference in New Issue
Block a user