docs: 更新 audio 和 scene 模块文档

- audio: 更新 i-audio-backend, i-audio-effect, wasapi-backend 方法文档
- scene: 更新 scene.md 模块总览
This commit is contained in:
2026-03-26 01:53:04 +08:00
parent fae7362e9f
commit 1f97102f33
4 changed files with 38 additions and 40 deletions

View File

@@ -16,22 +16,22 @@ IAudioBackend 是音频后端的抽象接口,定义了音频系统与具体音
| 方法 | 描述 |
|------|------|
| [`Initialize`](initialize.md) | 初始化音频后端 |
| [`Shutdown`](shutdown.md) | 关闭音频后端 |
| [`GetDeviceName`](get-device-name.md) | 获取设备名称 |
| [`GetAvailableDevices`](get-available-devices.md) | 获取可用设备列表 |
| [`SetDevice`](set-device.md) | 设置音频设备 |
| [`GetMasterVolume`](get-master-volume.md) | 获取主音量 |
| [`SetMasterVolume`](set-master-volume.md) | 设置主音量 |
| [`IsMuted`](is-muted.md) | 检查静音状态 |
| [`SetMuted`](set-muted.md) | 设置静音状态 |
| [`Start`](start.md) | 启动音频处理 |
| [`Stop`](stop.md) | 停止音频处理 |
| [`Suspend`](suspend.md) | 暂停音频处理 |
| [`Resume`](resume.md) | 恢复音频处理 |
| [`ProcessAudio`](process-audio.md) | 处理音频数据 |
| [`IsRunning`](is-running.md) | 检查是否正在运行 |
| [`GetConfig`](get-config.md) | 获取配置信息 |
| `Initialize` | 初始化音频后端 |
| `Shutdown` | 关闭音频后端 |
| `GetDeviceName` | 获取设备名称 |
| `GetAvailableDevices` | 获取可用设备列表 |
| `SetDevice` | 设置音频设备 |
| `GetMasterVolume` | 获取主音量 |
| `SetMasterVolume` | 设置主音量 |
| `IsMuted` | 检查静音状态 |
| `SetMuted` | 设置静音状态 |
| `Start` | 启动音频处理 |
| `Stop` | 停止音频处理 |
| `Suspend` | 暂停音频处理 |
| `Resume` | 恢复音频处理 |
| `ProcessAudio` | 处理音频数据 |
| `IsRunning` | 检查是否正在运行 |
| `GetConfig` | 获取配置信息 |
## 使用示例

View File

@@ -16,16 +16,16 @@ IAudioEffect 是所有音频效果处理器的抽象基类。它定义了音频
| 方法 | 描述 |
|------|------|
| [`ProcessAudio`](process-audio.md) | 处理音频数据(纯虚函数) |
| `ProcessAudio` | 处理音频数据(纯虚函数) |
## 虚方法
| 方法 | 描述 |
|------|------|
| [`SetEnabled`](set-enabled.md) | 设置启用状态 |
| [`IsEnabled`](is-enabled.md) | 检查启用状态 |
| [`SetWetMix`](set-wet-mix.md) | 设置湿信号混合比例 |
| [`GetWetMix`](get-wet-mix.md) | 获取湿信号混合比例 |
| `SetEnabled` | 设置启用状态 |
| `IsEnabled` | 检查启用状态 |
| `SetWetMix` | 设置湿信号混合比例 |
| `GetWetMix` | 获取湿信号混合比例 |
## 使用示例

View File

@@ -16,24 +16,22 @@ WASAPIBackend 是基于 Windows WASAPI 的音频后端实现,通过 Windows Mu
| 方法 | 描述 |
|------|------|
| [`WASAPIBackend`](constructor.md) | 构造函数 |
| [`~WASAPIBackend`](destructor.md) | 析构函数 |
| [`Initialize`](initialize.md) | 初始化 WASAPI 后端 |
| [`Shutdown`](shutdown.md) | 关闭 WASAPI 后端 |
| [`GetDeviceName`](get-device-name.md) | 获取当前设备名称 |
| [`GetAvailableDevices`](get-available-devices.md) | 获取可用设备列表 |
| [`SetDevice`](set-device.md) | 设置音频设备 |
| [`GetMasterVolume`](get-master-volume.md) | 获取主音量 |
| [`SetMasterVolume`](set-master-volume.md) | 设置主音量 |
| [`IsMuted`](is-muted.md) | 检查静音状态 |
| [`SetMuted`](set-muted.md) | 设置静音状态 |
| [`Start`](start.md) | 启动音频处理 |
| [`Stop`](stop.md) | 停止音频处理 |
| [`Suspend`](suspend.md) | 暂停音频处理 |
| [`Resume`](resume.md) | 恢复音频处理 |
| [`ProcessAudio`](process-audio.md) | 处理音频数据 |
| [`IsRunning`](is-running.md) | 检查是否正在运行 |
| [`GetConfig`](get-config.md) | 获取配置信息 |
| `Initialize` | 初始化 WASAPI 后端 |
| `Shutdown` | 关闭 WASAPI 后端 |
| `GetDeviceName` | 获取当前设备名称 |
| `GetAvailableDevices` | 获取可用设备列表 |
| `SetDevice` | 设置音频设备 |
| `GetMasterVolume` | 获取主音量 |
| `SetMasterVolume` | 设置主音量 |
| `IsMuted` | 检查静音状态 |
| `SetMuted` | 设置静音状态 |
| `Start` | 启动音频处理 |
| `Stop` | 停止音频处理 |
| `Suspend` | 暂停音频处理 |
| `Resume` | 恢复音频处理 |
| `ProcessAudio` | 处理音频数据 |
| `IsRunning` | 检查是否正在运行 |
| `GetConfig` | 获取配置信息 |
## 使用示例

View File

@@ -1,6 +1,6 @@
# Scene 模块概览
**命名空间**: `XCEngine::Scene`
**命名空间**: `XCEngine::Components`
**类型**: `module`