Files
XCEngine/docs/api/audio/audio-config/audio-config.md
ssdfasd 161a0896d5 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 添加模块导航
2026-03-22 01:56:16 +08:00

45 lines
1.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# AudioConfig
**命名空间**: `XCEngine::Audio`
**类型**: `struct`
**头文件**: `XCEngine/Audio/AudioConfig.h`
**描述**: 音频系统配置参数。
## 结构体成员
| 成员 | 类型 | 描述 | 默认值 |
|------|------|------|--------|
| `sampleRate` | `uint32_t` | 采样率Hz常用值44100, 48000 | `48000` |
| `channels` | `uint16_t` | 通道数1=单声道2=立体声 | `2` |
| `bitsPerSample` | `uint16_t` | 位深度常用值16, 24, 32 | `16` |
| `speakerMode` | `SpeakerMode` | 扬声器模式 | `SpeakerMode::Stereo` |
| `bufferSize` | `uint32_t` | 音频缓冲区大小(样本数) | `8192` |
| `bufferCount` | `uint32_t` | 缓冲区数量 | `2` |
## 使用示例
```cpp
#include <XCEngine/Audio/AudioConfig.h>
using namespace XCEngine::Audio;
AudioConfig CreateHighQualityConfig() {
AudioConfig config;
config.sampleRate = 48000;
config.channels = 2;
config.bitsPerSample = 24;
config.speakerMode = SpeakerMode::Stereo;
config.bufferSize = 4096;
config.bufferCount = 4;
return config;
}
```
## 相关文档
- [Audio 模块总览](../audio.md) - Audio 模块总览
- [AudioSystem](../audio-system/audio-system.md) - 音频系统