Files

ssdfasd 161a0896d5 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 添加模块导航

2026-03-22 01:56:16 +08:00

2.0 KiB

Raw Blame History

IAudioBackend

命名空间: XCEngine::Audio

类型: class (abstract)

头文件: XCEngine/Audio/IAudioBackend.h

描述: 音频后端抽象接口，定义音频输出的统一接口。

概述

IAudioBackend 是音频后端的抽象接口，定义了音频系统与具体音频 API（如 WASAPI、OpenAL）交互的统一接口。不同的音频后端实现（如 WASAPIBackend）继承此接口，提供实际的音频输出能力。

抽象方法

方法	描述
`Initialize`	初始化音频后端
`Shutdown`	关闭音频后端
`GetDeviceName`	获取设备名称
`GetAvailableDevices`	获取可用设备列表
`SetDevice`	设置音频设备
`GetMasterVolume`	获取主音量
`SetMasterVolume`	设置主音量
`IsMuted`	检查静音状态
`SetMuted`	设置静音状态
`Start`	启动音频处理
`Stop`	停止音频处理
`Suspend`	暂停音频处理
`Resume`	恢复音频处理
`ProcessAudio`	处理音频数据
`IsRunning`	检查是否正在运行
`GetConfig`	获取配置信息

使用示例

#include <XCEngine/Audio/IAudioBackend.h>
#include <XCEngine/Audio/WASAPI/WASAPIBackend.h>

using namespace XCEngine::Audio;

void CreateBackend() {
    IAudioBackend* backend = new WASAPIBackend();
    
    AudioConfig config;
    config.sampleRate = 48000;
    config.channels = 2;
    
    backend->Initialize(config);
    backend->Start();
}

2.0 KiB Raw Blame History Unescape Escape

IAudioBackend

概述

抽象方法

使用示例

相关文档

2.0 KiB

Raw Blame History