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:
40
docs/api/audio/audio-system/initialize.md
Normal file
40
docs/api/audio/audio-system/initialize.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# AudioSystem::Initialize
|
||||
|
||||
初始化音频系统。
|
||||
|
||||
```cpp
|
||||
void Initialize(const AudioConfig& config);
|
||||
```
|
||||
|
||||
使用指定的配置参数初始化音频系统。在此之前必须先通过 SetBackend 设置音频后端实现。初始化过程会配置音频缓冲区大小、采样率、通道数等参数。
|
||||
|
||||
**参数:**
|
||||
- `config` - 音频系统配置,包含采样率、通道数、位深度、扬声器模式、缓冲区大小等
|
||||
|
||||
**示例:**
|
||||
|
||||
```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>());
|
||||
|
||||
AudioConfig config;
|
||||
config.sampleRate = 48000;
|
||||
config.channels = 2;
|
||||
config.bitsPerSample = 16;
|
||||
config.speakerMode = SpeakerMode::Stereo;
|
||||
config.bufferSize = 8192;
|
||||
config.bufferCount = 2;
|
||||
|
||||
AudioSystem::Get().Initialize(config);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [AudioSystem 总览](audio-system.md)
|
||||
- [AudioConfig](../audio-config/audio-config.md) - 音频配置
|
||||
Reference in New Issue
Block a user