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:
34
docs/api/audio/audio-system/set-device.md
Normal file
34
docs/api/audio/audio-system/set-device.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# AudioSystem::SetDevice
|
||||
|
||||
设置音频设备。
|
||||
|
||||
```cpp
|
||||
void SetDevice(const std::string& deviceName);
|
||||
```
|
||||
|
||||
切换到指定的音频设备。如果设备名称无效或设备不可用,操作失败。
|
||||
|
||||
**参数:**
|
||||
- `deviceName` - 目标音频设备名称
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
using namespace XCEngine::Audio;
|
||||
|
||||
void SwitchAudioDevice() {
|
||||
std::vector<std::string> devices;
|
||||
AudioSystem::Get().GetAvailableDevices(devices);
|
||||
|
||||
if (devices.size() > 1) {
|
||||
AudioSystem::Get().SetDevice(devices[1]);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [AudioSystem 总览](audio-system.md)
|
||||
- [GetAvailableDevices](get-available-devices.md) - 获取可用设备列表
|
||||
Reference in New Issue
Block a user