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:
28
docs/api/audio/enums/audio-channel.md
Normal file
28
docs/api/audio/enums/audio-channel.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# AudioChannel
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
音频通道枚举,定义多声道音频系统中的各个声道。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `FrontLeft` | 0 | 前左声道 |
|
||||
| `FrontRight` | 1 | 前右声道 |
|
||||
| `FrontCenter` | 2 | 前中声道 |
|
||||
| `LFE` | 3 | 低频效果声道(低音炮) |
|
||||
| `BackLeft` | 4 | 后左声道 |
|
||||
| `BackRight` | 5 | 后右声道 |
|
||||
| `SideLeft` | 6 | 侧左声道 |
|
||||
| `SideRight` | 7 | 侧右声道 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
26
docs/api/audio/enums/audio-format.md
Normal file
26
docs/api/audio/enums/audio-format.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# AudioFormat
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
支持的音频格式枚举。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Unknown` | 0 | 未知格式 |
|
||||
| `WAV` | 1 | WAV 格式(Microsoft) |
|
||||
| `OGG` | 2 | OGG Vorbis 格式 |
|
||||
| `MP3` | 3 | MP3 格式(MPEG-1 Audio Layer 3) |
|
||||
| `FLAC` | 4 | FLAC 格式(Free Lossless Audio Codec) |
|
||||
| `AAC` | 5 | AAC 格式(Advanced Audio Coding) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
24
docs/api/audio/enums/audio-load-state.md
Normal file
24
docs/api/audio/enums/audio-load-state.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# AudioLoadState
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
音频资源加载状态枚举。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Unloaded` | 0 | 未加载 |
|
||||
| `Loading` | 1 | 正在加载 |
|
||||
| `Loaded` | 2 | 已加载 |
|
||||
| `Failed` | 3 | 加载失败 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
23
docs/api/audio/enums/audio-resource-type.md
Normal file
23
docs/api/audio/enums/audio-resource-type.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# AudioResourceType
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
音频资源类型枚举,区分不同种类的音频资源。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `AudioClip` | 0 | 音频片段资源 |
|
||||
| `AudioMixer` | 1 | 音频混音器资源 |
|
||||
| `AudioBank` | 2 | 音频银行/打包资源 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
22
docs/api/audio/enums/pan-mode.md
Normal file
22
docs/api/audio/enums/pan-mode.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# PanMode
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
声像模式枚举,控制 2D/3D 声像定位方式。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Pan3D` | 0 | 3D 空间化声像 |
|
||||
| `Pan2D` | 1 | 2D 平坦声像 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
23
docs/api/audio/enums/play-state.md
Normal file
23
docs/api/audio/enums/play-state.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# PlayState
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
音频播放状态枚举。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Stopped` | 0 | 已停止 |
|
||||
| `Playing` | 1 | 正在播放 |
|
||||
| `Paused` | 2 | 已暂停 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
26
docs/api/audio/enums/speaker-mode.md
Normal file
26
docs/api/audio/enums/speaker-mode.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# SpeakerMode
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
扬声器输出模式枚举,定义音频输出的声道配置。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Mono` | 0 | 单声道 |
|
||||
| `Stereo` | 1 | 立体声(2.0) |
|
||||
| `Surround51` | 2 | 5.1 环绕声 |
|
||||
| `Surround71` | 3 | 7.1 环绕声 |
|
||||
| `Surround51_2` | 4 | 5.1 环绕声(第二版) |
|
||||
| `Surround71_2` | 5 | 7.1 环绕声(第二版) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
22
docs/api/audio/enums/stop-mode.md
Normal file
22
docs/api/audio/enums/stop-mode.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# StopMode
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
音频停止模式枚举,控制停止播放时的行为。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Immediate` | 0 | 立即停止 |
|
||||
| `AllowFadeOut` | 1 | 允许淡出后停止 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
24
docs/api/audio/enums/volume-source.md
Normal file
24
docs/api/audio/enums/volume-source.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# VolumeSource
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
## 概述
|
||||
|
||||
音量来源枚举,定义不同物理因素对音量的影响。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Direct` | 0 | 直接音量(无遮挡) |
|
||||
| `PathOcclusion` | 1 | 路径遮挡(声波绕过障碍物) |
|
||||
| `Transmission` | 2 | 透射(声波穿透障碍物) |
|
||||
| `Obstruction` | 3 | 阻塞(直达声被完全遮挡) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||||
Reference in New Issue
Block a user