refactor api documentation structure
This commit is contained in:
51
docs/api/XCEngine/Audio/AudioSystem/AudioSystem.md
Normal file
51
docs/api/XCEngine/Audio/AudioSystem/AudioSystem.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# AudioSystem
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class (singleton)`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioSystem` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`AudioSystem.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `AudioSystem` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Get](Get.md) | 获取相关状态或对象。 |
|
||||
| [Initialize](Initialize.md) | 初始化内部状态。 |
|
||||
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
|
||||
| [Update](Update.md) | 更新运行时状态。 |
|
||||
| [SetBackend](SetBackend.md) | 设置相关状态或配置。 |
|
||||
| [GetBackend](GetBackend.md) | 获取相关状态或对象。 |
|
||||
| [GetCurrentDevice](GetCurrentDevice.md) | 获取相关状态或对象。 |
|
||||
| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
|
||||
| [GetAvailableDevices](GetAvailableDevices.md) | 获取相关状态或对象。 |
|
||||
| [GetMasterVolume](GetMasterVolume.md) | 获取相关状态或对象。 |
|
||||
| [SetMasterVolume](SetMasterVolume.md) | 设置相关状态或配置。 |
|
||||
| [IsMuted](IsMuted.md) | 查询当前状态。 |
|
||||
| [SetMuted](SetMuted.md) | 设置相关状态或配置。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetListenerTransform](SetListenerTransform.md) | 设置相关状态或配置。 |
|
||||
| [SetListenerVelocity](SetListenerVelocity.md) | 设置相关状态或配置。 |
|
||||
| [GetListenerPosition](GetListenerPosition.md) | 获取相关状态或对象。 |
|
||||
| [GetListenerRotation](GetListenerRotation.md) | 获取相关状态或对象。 |
|
||||
| [GetListenerVelocity](GetListenerVelocity.md) | 获取相关状态或对象。 |
|
||||
| [RegisterSource](RegisterSource.md) | 注册对象、回调或映射。 |
|
||||
| [UnregisterSource](UnregisterSource.md) | 取消注册对象、回调或映射。 |
|
||||
| [GetStats](GetStats.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user