ssdfasd
161a0896d5
- 新增 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 添加模块导航
50 lines
1.4 KiB
Markdown
50 lines
1.4 KiB
Markdown
# IAudioEffect
|
||
|
||
**命名空间**: `XCEngine::Audio`
|
||
|
||
**类型**: `class (abstract)`
|
||
|
||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||
|
||
**描述**: 音频效果接口基类，定义音频效果处理的统一接口。
|
||
|
||
## 概述
|
||
|
||
IAudioEffect 是所有音频效果处理器的抽象基类。它定义了音频效果的基本接口，包括音频处理方法、启用/禁用状态和干湿混合比例。具体的音频效果（如 Reverbation、Equalizer、FFTFilter）继承此接口并实现 ProcessAudio 方法来处理音频数据。
|
||
|
||
## 抽象方法
|
||
|
||
| 方法 | 描述 |
|
||
|------|------|
|
||
| [`ProcessAudio`](process-audio.md) | 处理音频数据（纯虚函数） |
|
||
|
||
## 虚方法
|
||
|
||
| 方法 | 描述 |
|
||
|------|------|
|
||
| [`SetEnabled`](set-enabled.md) | 设置启用状态 |
|
||
| [`IsEnabled`](is-enabled.md) | 检查启用状态 |
|
||
| [`SetWetMix`](set-wet-mix.md) | 设置湿信号混合比例 |
|
||
| [`GetWetMix`](get-wet-mix.md) | 获取湿信号混合比例 |
|
||
|
||
## 使用示例
|
||
|
||
```cpp
|
||
#include <XCEngine/Audio/IAudioEffect.h>
|
||
#include <XCEngine/Audio/Reverbation.h>
|
||
|
||
using namespace XCEngine::Audio;
|
||
|
||
void ConfigureEffect(IAudioEffect* effect) {
|
||
effect->SetEnabled(true);
|
||
effect->SetWetMix(0.5f);
|
||
}
|
||
```
|
||
|
||
## 相关文档
|
||
|
||
- [Audio 模块总览](../audio.md) - Audio 模块总览
|
||
- [AudioMixer](../audio-mixer/audio-mixer.md) - 音频混音器
|
||
- [Reverbation](../reverbation/reverbation.md) - 混响效果
|
||
- [Equalizer](../equalizer/equalizer.md) - 均衡器效果
|