Files
XCEngine/docs/api/audio/i-audio-effect/i-audio-effect.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

# IAudioEffect
**命名空间**: `XCEngine::Audio`
**类型**: `class (abstract)`
**头文件**: `XCEngine/Audio/IAudioEffect.h`
**描述**: 音频效果接口基类,定义音频效果处理的统一接口。
## 概述
IAudioEffect 是所有音频效果处理器的抽象基类。它定义了音频效果的基本接口,包括音频处理方法、启用/禁用状态和干湿混合比例。具体的音频效果(如 Reverbation、Equalizer、FFTFilter继承此接口并实现 ProcessAudio 方法来处理音频数据。
## 抽象方法
| 方法 | 描述 |
|------|------|
| `ProcessAudio` | 处理音频数据(纯虚函数) |
## 虚方法
| 方法 | 描述 |
|------|------|
| `SetEnabled` | 设置启用状态 |
| `IsEnabled` | 检查启用状态 |
| `SetWetMix` | 设置湿信号混合比例 |
| `GetWetMix` | 获取湿信号混合比例 |
## 使用示例
```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) - 均衡器效果