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:
30
docs/api/audio/audio-system/set-backend.md
Normal file
30
docs/api/audio/audio-system/set-backend.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::SetBackend
|
||||
|
||||
设置音频后端实现。
|
||||
|
||||
```cpp
|
||||
void SetBackend(std::unique_ptr<IAudioBackend> backend);
|
||||
```
|
||||
|
||||
设置音频系统的后端实现。必须在调用 Initialize 之前设置后端。音频系统不拥有后端的所有权,后端通过 unique_ptr 传递。
|
||||
|
||||
**参数:**
|
||||
- `backend` - 音频后端实现的 unique_ptr,支持 IAudioBackend 接口
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
#include <XCEngine/Audio/WASAPI/WASAPIBackend.h>
|
||||
|
||||
using namespace XCEngine::Audio;
|
||||
|
||||
void SetupAudio() {
|
||||
AudioSystem::Get().SetBackend(std::make_unique<WASAPIBackend>());
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [AudioSystem 总览](audio-system.md)
|
||||
- [IAudioBackend](../i-audio-backend/i-audio-backend.md) - 音频后端接口
|
||||
Reference in New Issue
Block a user