refactor(docs): fix Audio module documentation links and add missing getter docs

This commit is contained in:
2026-03-26 01:54:45 +08:00
parent 1f97102f33
commit 1326860e5d
10 changed files with 94 additions and 24 deletions

View File

@@ -16,20 +16,20 @@ AudioMixer 是 XCEngine 音频模块中的混音器类,负责将多个音频
| 方法 | 描述 |
|------|------|
| `SetVolume` | 设置混音器音量 |
| `GetVolume` | 获取混音器音量 |
| `SetMute` | 设置静音状态 |
| `IsMute` | 检查静音状态 |
| `AddEffect` | 添加音频效果 |
| `RemoveEffect` | 移除音频效果 |
| `ClearEffects` | 清除所有效果 |
| `ProcessAudio` | 处理音频数据 |
| `SetOutputMixer` | 设置输出混音器 |
| `GetOutputMixer` | 获取输出混音器 |
| `Set3DParams` | 设置 3D 空间化参数 |
| `Get3DParams` | 获取 3D 空间化参数 |
| `SetChannelVolume` | 设置通道音量 |
| `GetChannelVolume` | 获取通道音量 |
| [`SetVolume`](set-volume.md) | 设置混音器音量 |
| [`GetVolume`](get-volume.md) | 获取混音器音量 |
| [`SetMute`](set-mute.md) | 设置静音状态 |
| [`IsMute`](is-mute.md) | 检查静音状态 |
| [`AddEffect`](add-effect.md) | 添加音频效果 |
| [`RemoveEffect`](remove-effect.md) | 移除音频效果 |
| [`ClearEffects`](clear-effects.md) | 清除所有效果 |
| [`ProcessAudio`](process-audio.md) | 处理音频数据 |
| [`SetOutputMixer`](set-output-mixer.md) | 设置输出混音器 |
| [`GetOutputMixer`](get-output-mixer.md) | 获取输出混音器 |
| [`Set3DParams`](set-3d-params.md) | 设置 3D 空间化参数 |
| [`Get3DParams`](get-3d-params.md) | 获取 3D 空间化参数 |
| [`SetChannelVolume`](set-channel-volume.md) | 设置通道音量 |
| [`GetChannelVolume`](get-channel-volume.md) | 获取通道音量 |
## 使用示例

View File

@@ -0,0 +1,15 @@
# AudioMixer::Get3DParams
获取 3D 空间化参数。
```cpp
const Audio3DParams& Get3DParams() const;
```
**返回:** `const Audio3DParams&` - 3D 空间化参数结构体引用
## 相关文档
- [AudioMixer 总览](audio-mixer.md)
- [Set3DParams](set-3d-params.md) - 设置 3D 空间化参数
- [Audio3DParams](../audio-3d-params/audio-3d-params.md) - 3D 空间化参数

View File

@@ -0,0 +1,14 @@
# AudioMixer::GetOutputMixer
获取输出混音器。
```cpp
AudioMixer* GetOutputMixer() const;
```
**返回:** `AudioMixer*` - 父混音器指针,如果直接输出到后端则返回 nullptr
## 相关文档
- [AudioMixer 总览](audio-mixer.md)
- [SetOutputMixer](set-output-mixer.md) - 设置输出混音器

View File

@@ -0,0 +1,14 @@
# AudioMixer::GetVolume
获取混音器音量。
```cpp
float GetVolume() const;
```
**返回:** `float` - 混音器音量值,范围 [0.0, 1.0]
## 相关文档
- [AudioMixer 总览](audio-mixer.md)
- [SetVolume](set-volume.md) - 设置混音器音量

View File

@@ -0,0 +1,14 @@
# AudioMixer::IsMute
检查混音器静音状态。
```cpp
bool IsMute() const;
```
**返回:** `bool` - 如果当前处于静音状态则返回 true
## 相关文档
- [AudioMixer 总览](audio-mixer.md)
- [SetMute](set-mute.md) - 设置混音器静音状态

View File

@@ -54,7 +54,7 @@ AudioSystem 是 XCEngine 音频模块的核心单例类,负责管理整个音
```cpp
#include <XCEngine/Audio/AudioSystem.h>
#include <XCEngine/Audio/WASAPI/WASAPIBackend.h>
#include <XCEngine/Audio/WindowsAudioBackend.h>
using namespace XCEngine::Audio;
@@ -65,7 +65,7 @@ void SetupAudio() {
config.bitsPerSample = 16;
config.speakerMode = SpeakerMode::Stereo;
AudioSystem::Get().SetBackend(std::make_unique<WASAPIBackend>());
AudioSystem::Get().SetBackend(std::make_unique<WASAPI::WASAPIBackend>());
AudioSystem::Get().Initialize(config);
}

View File

@@ -0,0 +1,15 @@
# AudioSystem::GetBackend
获取当前音频后端。
```cpp
IAudioBackend* GetBackend() const;
```
**返回:** `IAudioBackend*` - 当前音频后端指针,如果未设置则返回 nullptr
## 相关文档
- [AudioSystem 总览](audio-system.md)
- [SetBackend](set-backend.md) - 设置音频后端
- [IAudioBackend](../i-audio-backend/i-audio-backend.md) - 音频后端接口

View File

@@ -34,7 +34,7 @@ Audio 模块是 XCEngine 的音频子系统支持多通道音频播放、3D
| 组件 | 文件 | 描述 |
|------|------|------|
| [WASAPIBackend](wasapi-backend/wasapi-backend.md) | `WASAPI/WASAPIBackend.h` | Windows WASAPI 音频后端实现 |
| [WASAPIBackend](wasapi-backend/wasapi-backend.md) | `XCEngine/Audio/WindowsAudioBackend.h` | Windows WASAPI 音频后端实现 |
### 配置与类型
@@ -106,6 +106,4 @@ void UpdateListener(const Math::Vector3& pos, const Math::Quaternion& rot) {
## 相关文档
- [Resources 模块 - AudioClip](../resources/audioclip/audio-clip.md) - 音频资源管理
- [Components 模块 - AudioSourceComponent](../components/audio-source-component/audio-source-component.md) - 音频源组件
- [Components 模块 - AudioListenerComponent](../components/audio-listener-component/audio-listener-component.md) - 音频监听器组件
- [Resources 模块 - AudioLoader](../resources/audio-loader/index.md) - 音频资源管理

View File

@@ -37,12 +37,12 @@ IAudioBackend 是音频后端的抽象接口,定义了音频系统与具体音
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
#include <XCEngine/Audio/WASAPI/WASAPIBackend.h>
#include <XCEngine/Audio/WindowsAudioBackend.h>
using namespace XCEngine::Audio;
void CreateBackend() {
IAudioBackend* backend = new WASAPIBackend();
IAudioBackend* backend = new WASAPI::WASAPIBackend();
AudioConfig config;
config.sampleRate = 48000;

View File

@@ -4,7 +4,7 @@
**类型**: `class`
**头文件**: `XCEngine/Audio/WASAPI/WASAPIBackend.h`
**头文件**: `XCEngine/Audio/WindowsAudioBackend.h`
**描述**: Windows Audio Session API (WASAPI) 音频后端实现。
@@ -37,7 +37,7 @@ WASAPIBackend 是基于 Windows WASAPI 的音频后端实现,通过 Windows Mu
```cpp
#include <XCEngine/Audio/AudioSystem.h>
#include <XCEngine/Audio/WASAPI/WASAPIBackend.h>
#include <XCEngine/Audio/WindowsAudioBackend.h>
using namespace XCEngine::Audio;