refactor api documentation structure
This commit is contained in:
30
docs/api/XCEngine/Audio/Audio.md
Normal file
30
docs/api/XCEngine/Audio/Audio.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Audio
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `module`
|
||||
|
||||
**描述**: 音频系统、混音器、效果器与后端接口。
|
||||
|
||||
## 概览
|
||||
|
||||
该目录与 `XCEngine/Audio` 对应的 public headers 保持平行,用于承载唯一的 canonical API 文档入口。
|
||||
|
||||
## 头文件
|
||||
|
||||
- [AudioConfig](AudioConfig/AudioConfig.md) - `AudioConfig.h`
|
||||
- [AudioMixer](AudioMixer/AudioMixer.md) - `AudioMixer.h`
|
||||
- [AudioSystem](AudioSystem/AudioSystem.md) - `AudioSystem.h`
|
||||
- [AudioTypes](AudioTypes/AudioTypes.md) - `AudioTypes.h`
|
||||
- [Equalizer](Equalizer/Equalizer.md) - `Equalizer.h`
|
||||
- [FFTFilter](FFTFilter/FFTFilter.md) - `FFTFilter.h`
|
||||
- [HRTF](HRTF/HRTF.md) - `HRTF.h`
|
||||
- [IAudioBackend](IAudioBackend/IAudioBackend.md) - `IAudioBackend.h`
|
||||
- [IAudioEffect](IAudioEffect/IAudioEffect.md) - `IAudioEffect.h`
|
||||
- [Reverbation](Reverbation/Reverbation.md) - `Reverbation.h`
|
||||
- [WindowsAudioBackend](WindowsAudioBackend/WindowsAudioBackend.md) - `WindowsAudioBackend.h`
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [上级目录](../XCEngine.md)
|
||||
- [API 总索引](../../main.md)
|
||||
35
docs/api/XCEngine/Audio/AudioConfig/AudioConfig.md
Normal file
35
docs/api/XCEngine/Audio/AudioConfig/AudioConfig.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# AudioConfig
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioConfig.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioConfig` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`AudioConfig.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `AudioConfig` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `sampleRate` | `uint32_t` | 结构体公开字段。 | `48000` |
|
||||
| `channels` | `uint16` | 结构体公开字段。 | `2` |
|
||||
| `bitsPerSample` | `uint16` | 结构体公开字段。 | `16` |
|
||||
| `speakerMode` | `SpeakerMode` | 结构体公开字段。 | `SpeakerMode::Stereo` |
|
||||
| `bufferSize` | `uint32` | 结构体公开字段。 | `8192` |
|
||||
| `bufferCount` | `uint32` | 结构体公开字段。 | `2` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/AddEffect.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/AddEffect.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::AddEffect
|
||||
|
||||
添加元素或建立关联。
|
||||
|
||||
```cpp
|
||||
void AddEffect(IAudioEffect* effect);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `effect` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::AddEffect(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
45
docs/api/XCEngine/Audio/AudioMixer/AudioMixer.md
Normal file
45
docs/api/XCEngine/Audio/AudioMixer/AudioMixer.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# AudioMixer
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioMixer` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`AudioMixer.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `AudioMixer` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [AudioMixer()](Constructor.md) | 构造对象。 |
|
||||
| [~AudioMixer()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [SetVolume](SetVolume.md) | 设置相关状态或配置。 |
|
||||
| [GetVolume](GetVolume.md) | 获取相关状态或对象。 |
|
||||
| [SetMute](SetMute.md) | 设置相关状态或配置。 |
|
||||
| [IsMute](IsMute.md) | 查询当前状态。 |
|
||||
| [AddEffect](AddEffect.md) | 添加元素或建立关联。 |
|
||||
| [RemoveEffect](RemoveEffect.md) | 移除元素或解除关联。 |
|
||||
| [ClearEffects](ClearEffects.md) | 清空内部数据。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetOutputMixer](SetOutputMixer.md) | 设置相关状态或配置。 |
|
||||
| [GetOutputMixer](GetOutputMixer.md) | 获取相关状态或对象。 |
|
||||
| [Set3DParams](Set3DParams.md) | 设置相关状态或配置。 |
|
||||
| [Get3DParams](Get3DParams.md) | 获取相关状态或对象。 |
|
||||
| [SetChannelVolume](SetChannelVolume.md) | 设置相关状态或配置。 |
|
||||
| [GetChannelVolume](GetChannelVolume.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
30
docs/api/XCEngine/Audio/AudioMixer/ClearEffects.md
Normal file
30
docs/api/XCEngine/Audio/AudioMixer/ClearEffects.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioMixer::ClearEffects
|
||||
|
||||
清空内部数据。
|
||||
|
||||
```cpp
|
||||
void ClearEffects();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::ClearEffects(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
28
docs/api/XCEngine/Audio/AudioMixer/Constructor.md
Normal file
28
docs/api/XCEngine/Audio/AudioMixer/Constructor.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# AudioMixer::AudioMixer()
|
||||
|
||||
构造对象。
|
||||
|
||||
```cpp
|
||||
AudioMixer();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
29
docs/api/XCEngine/Audio/AudioMixer/Destructor.md
Normal file
29
docs/api/XCEngine/Audio/AudioMixer/Destructor.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AudioMixer::~AudioMixer()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
|
||||
```cpp
|
||||
~AudioMixer();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioMixer/Get3DParams.md
Normal file
30
docs/api/XCEngine/Audio/AudioMixer/Get3DParams.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioMixer::Get3DParams
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const Audio3DParams& Get3DParams() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const Audio3DParams&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::Get3DParams(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/GetChannelVolume.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/GetChannelVolume.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::GetChannelVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetChannelVolume(AudioChannel channel) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `channel` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::GetChannelVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioMixer/GetOutputMixer.md
Normal file
30
docs/api/XCEngine/Audio/AudioMixer/GetOutputMixer.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioMixer::GetOutputMixer
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
AudioMixer* GetOutputMixer() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `AudioMixer*` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::GetOutputMixer(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioMixer/GetVolume.md
Normal file
30
docs/api/XCEngine/Audio/AudioMixer/GetVolume.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioMixer::GetVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetVolume() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::GetVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioMixer/IsMute.md
Normal file
30
docs/api/XCEngine/Audio/AudioMixer/IsMute.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioMixer::IsMute
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
bool IsMute() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::IsMute(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
33
docs/api/XCEngine/Audio/AudioMixer/ProcessAudio.md
Normal file
33
docs/api/XCEngine/Audio/AudioMixer/ProcessAudio.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# AudioMixer::ProcessAudio
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/RemoveEffect.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/RemoveEffect.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::RemoveEffect
|
||||
|
||||
移除元素或解除关联。
|
||||
|
||||
```cpp
|
||||
void RemoveEffect(IAudioEffect* effect);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `effect` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::RemoveEffect(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/Set3DParams.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/Set3DParams.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::Set3DParams
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void Set3DParams(const Audio3DParams& params);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `params` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::Set3DParams(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
32
docs/api/XCEngine/Audio/AudioMixer/SetChannelVolume.md
Normal file
32
docs/api/XCEngine/Audio/AudioMixer/SetChannelVolume.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# AudioMixer::SetChannelVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetChannelVolume(AudioChannel channel, float volume);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `channel` - 参数语义详见头文件声明。
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetChannelVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/SetMute.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/SetMute.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::SetMute
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetMute(bool mute);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `mute` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetMute(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/SetOutputMixer.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/SetOutputMixer.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::SetOutputMixer
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetOutputMixer(AudioMixer* mixer);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `mixer` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetOutputMixer(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioMixer/SetVolume.md
Normal file
31
docs/api/XCEngine/Audio/AudioMixer/SetVolume.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioMixer::SetVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetVolume(float volume);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`,当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
51
docs/api/XCEngine/Audio/AudioSystem/AudioSystem.md
Normal file
51
docs/api/XCEngine/Audio/AudioSystem/AudioSystem.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# AudioSystem
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class (singleton)`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioSystem` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`AudioSystem.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `AudioSystem` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Get](Get.md) | 获取相关状态或对象。 |
|
||||
| [Initialize](Initialize.md) | 初始化内部状态。 |
|
||||
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
|
||||
| [Update](Update.md) | 更新运行时状态。 |
|
||||
| [SetBackend](SetBackend.md) | 设置相关状态或配置。 |
|
||||
| [GetBackend](GetBackend.md) | 获取相关状态或对象。 |
|
||||
| [GetCurrentDevice](GetCurrentDevice.md) | 获取相关状态或对象。 |
|
||||
| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
|
||||
| [GetAvailableDevices](GetAvailableDevices.md) | 获取相关状态或对象。 |
|
||||
| [GetMasterVolume](GetMasterVolume.md) | 获取相关状态或对象。 |
|
||||
| [SetMasterVolume](SetMasterVolume.md) | 设置相关状态或配置。 |
|
||||
| [IsMuted](IsMuted.md) | 查询当前状态。 |
|
||||
| [SetMuted](SetMuted.md) | 设置相关状态或配置。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetListenerTransform](SetListenerTransform.md) | 设置相关状态或配置。 |
|
||||
| [SetListenerVelocity](SetListenerVelocity.md) | 设置相关状态或配置。 |
|
||||
| [GetListenerPosition](GetListenerPosition.md) | 获取相关状态或对象。 |
|
||||
| [GetListenerRotation](GetListenerRotation.md) | 获取相关状态或对象。 |
|
||||
| [GetListenerVelocity](GetListenerVelocity.md) | 获取相关状态或对象。 |
|
||||
| [RegisterSource](RegisterSource.md) | 注册对象、回调或映射。 |
|
||||
| [UnregisterSource](UnregisterSource.md) | 取消注册对象、回调或映射。 |
|
||||
| [GetStats](GetStats.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
29
docs/api/XCEngine/Audio/AudioSystem/Get.md
Normal file
29
docs/api/XCEngine/Audio/AudioSystem/Get.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AudioSystem::Get
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
static AudioSystem& Get();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `AudioSystem&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
auto& instance = XCEngine::Audio::AudioSystem::Get();
|
||||
(void)instance;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/GetAvailableDevices.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/GetAvailableDevices.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::GetAvailableDevices
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
void GetAvailableDevices(std::vector<std::string>& devices);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `devices` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetAvailableDevices(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetBackend.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetBackend.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetBackend
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
IAudioBackend* GetBackend() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `IAudioBackend*` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetBackend(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetCurrentDevice.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetCurrentDevice.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetCurrentDevice
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
std::string GetCurrentDevice() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `std::string` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetCurrentDevice(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetListenerPosition.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetListenerPosition.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetListenerPosition
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const Math::Vector3& GetListenerPosition() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const Math::Vector3&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetListenerPosition(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetListenerRotation.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetListenerRotation.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetListenerRotation
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const Math::Quaternion& GetListenerRotation() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const Math::Quaternion&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetListenerRotation(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetListenerVelocity.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetListenerVelocity.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetListenerVelocity
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const Math::Vector3& GetListenerVelocity() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const Math::Vector3&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetListenerVelocity(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetMasterVolume.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetMasterVolume.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetMasterVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetMasterVolume() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetMasterVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/GetStats.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/GetStats.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::GetStats
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const Stats& GetStats() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const Stats&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetStats(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/Initialize.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/Initialize.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
|
||||
```cpp
|
||||
void Initialize(const AudioConfig& config);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `config` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/IsMuted.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/IsMuted.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::IsMuted
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
bool IsMuted() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::IsMuted(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
33
docs/api/XCEngine/Audio/AudioSystem/ProcessAudio.md
Normal file
33
docs/api/XCEngine/Audio/AudioSystem/ProcessAudio.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# AudioSystem::ProcessAudio
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/RegisterSource.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/RegisterSource.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::RegisterSource
|
||||
|
||||
注册对象、回调或映射。
|
||||
|
||||
```cpp
|
||||
void RegisterSource(Components::AudioSourceComponent* source);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `source` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::RegisterSource(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/SetBackend.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/SetBackend.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::SetBackend
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetBackend(std::unique_ptr<IAudioBackend> backend);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `backend` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetBackend(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/SetDevice.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/SetDevice.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::SetDevice
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetDevice(const std::string& deviceName);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `deviceName` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetDevice(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
32
docs/api/XCEngine/Audio/AudioSystem/SetListenerTransform.md
Normal file
32
docs/api/XCEngine/Audio/AudioSystem/SetListenerTransform.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# AudioSystem::SetListenerTransform
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetListenerTransform(const Math::Vector3& position, const Math::Quaternion& rotation);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `position` - 参数语义详见头文件声明。
|
||||
- `rotation` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetListenerTransform(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/SetListenerVelocity.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/SetListenerVelocity.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::SetListenerVelocity
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetListenerVelocity(const Math::Vector3& velocity);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `velocity` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetListenerVelocity(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/SetMasterVolume.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/SetMasterVolume.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::SetMasterVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetMasterVolume(float volume);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetMasterVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/SetMuted.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/SetMuted.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::SetMuted
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetMuted(bool muted);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `muted` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetMuted(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/AudioSystem/Shutdown.md
Normal file
30
docs/api/XCEngine/Audio/AudioSystem/Shutdown.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AudioSystem::Shutdown
|
||||
|
||||
关闭并清理内部状态。
|
||||
|
||||
```cpp
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::Shutdown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/UnregisterSource.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/UnregisterSource.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::UnregisterSource
|
||||
|
||||
取消注册对象、回调或映射。
|
||||
|
||||
```cpp
|
||||
void UnregisterSource(Components::AudioSourceComponent* source);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `source` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::UnregisterSource(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/AudioSystem/Update.md
Normal file
31
docs/api/XCEngine/Audio/AudioSystem/Update.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AudioSystem::Update
|
||||
|
||||
更新运行时状态。
|
||||
|
||||
```cpp
|
||||
void Update(float deltaTime);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`,当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `deltaTime` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::Update(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
43
docs/api/XCEngine/Audio/AudioTypes/AudioTypes.md
Normal file
43
docs/api/XCEngine/Audio/AudioTypes/AudioTypes.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# AudioTypes
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioTypes.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioTypes` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`AudioTypes.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `AudioResourceType` | `enum class` | 头文件中的公开声明。 |
|
||||
| `AudioLoadState` | `enum class` | 头文件中的公开声明。 |
|
||||
| `AudioFormat` | `enum class` | 头文件中的公开声明。 |
|
||||
| `SpeakerMode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `AudioChannel` | `enum class` | 头文件中的公开声明。 |
|
||||
| `PlayState` | `enum class` | 头文件中的公开声明。 |
|
||||
| `StopMode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `PanMode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `VolumeSource` | `enum class` | 头文件中的公开声明。 |
|
||||
| `Audio3DParams` | `struct` | 头文件中的公开声明。 |
|
||||
| `AudioBufferDesc` | `struct` | 头文件中的公开声明。 |
|
||||
| `SpatializerParams` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `AudioClip` | - | 枚举项。 |
|
||||
| `AudioMixer` | - | 枚举项。 |
|
||||
| `AudioBank` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
28
docs/api/XCEngine/Audio/Equalizer/Constructor.md
Normal file
28
docs/api/XCEngine/Audio/Equalizer/Constructor.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Equalizer::Equalizer()
|
||||
|
||||
构造对象。
|
||||
|
||||
```cpp
|
||||
Equalizer();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
29
docs/api/XCEngine/Audio/Equalizer/Destructor.md
Normal file
29
docs/api/XCEngine/Audio/Equalizer/Destructor.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Equalizer::~Equalizer()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
|
||||
```cpp
|
||||
~Equalizer() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
44
docs/api/XCEngine/Audio/Equalizer/Equalizer.md
Normal file
44
docs/api/XCEngine/Audio/Equalizer/Equalizer.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Equalizer
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `Equalizer` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`Equalizer.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `Equalizer` | `class` | 继承自 `IAudioEffect` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Equalizer()](Constructor.md) | 构造对象。 |
|
||||
| [~Equalizer()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetBandCount](SetBandCount.md) | 设置相关状态或配置。 |
|
||||
| [GetBandCount](GetBandCount.md) | 获取相关状态或对象。 |
|
||||
| [SetBandFrequency](SetBandFrequency.md) | 设置相关状态或配置。 |
|
||||
| [GetBandFrequency](GetBandFrequency.md) | 获取相关状态或对象。 |
|
||||
| [SetBandGain](SetBandGain.md) | 设置相关状态或配置。 |
|
||||
| [GetBandGain](GetBandGain.md) | 获取相关状态或对象。 |
|
||||
| [SetBandQ](SetBandQ.md) | 设置相关状态或配置。 |
|
||||
| [GetBandQ](GetBandQ.md) | 获取相关状态或对象。 |
|
||||
| [SetEnabled](SetEnabled.md) | 设置相关状态或配置。 |
|
||||
| [IsEnabled](IsEnabled.md) | 查询当前状态。 |
|
||||
| [SetWetMix](SetWetMix.md) | 设置相关状态或配置。 |
|
||||
| [GetWetMix](GetWetMix.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
30
docs/api/XCEngine/Audio/Equalizer/GetBandCount.md
Normal file
30
docs/api/XCEngine/Audio/Equalizer/GetBandCount.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Equalizer::GetBandCount
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
uint32 GetBandCount() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `uint32` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetBandCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/Equalizer/GetBandFrequency.md
Normal file
31
docs/api/XCEngine/Audio/Equalizer/GetBandFrequency.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Equalizer::GetBandFrequency
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetBandFrequency(uint32 band) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetBandFrequency(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/Equalizer/GetBandGain.md
Normal file
31
docs/api/XCEngine/Audio/Equalizer/GetBandGain.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Equalizer::GetBandGain
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetBandGain(uint32 band) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetBandGain(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/Equalizer/GetBandQ.md
Normal file
31
docs/api/XCEngine/Audio/Equalizer/GetBandQ.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Equalizer::GetBandQ
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetBandQ(uint32 band) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetBandQ(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/Equalizer/GetWetMix.md
Normal file
30
docs/api/XCEngine/Audio/Equalizer/GetWetMix.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Equalizer::GetWetMix
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetWetMix() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetWetMix(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/Equalizer/IsEnabled.md
Normal file
30
docs/api/XCEngine/Audio/Equalizer/IsEnabled.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Equalizer::IsEnabled
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
bool IsEnabled() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::IsEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
33
docs/api/XCEngine/Audio/Equalizer/ProcessAudio.md
Normal file
33
docs/api/XCEngine/Audio/Equalizer/ProcessAudio.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Equalizer::ProcessAudio
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/Equalizer/SetBandCount.md
Normal file
31
docs/api/XCEngine/Audio/Equalizer/SetBandCount.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Equalizer::SetBandCount
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetBandCount(uint32 count);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `count` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
32
docs/api/XCEngine/Audio/Equalizer/SetBandFrequency.md
Normal file
32
docs/api/XCEngine/Audio/Equalizer/SetBandFrequency.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Equalizer::SetBandFrequency
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetBandFrequency(uint32 band, float frequency);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
- `frequency` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandFrequency(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
32
docs/api/XCEngine/Audio/Equalizer/SetBandGain.md
Normal file
32
docs/api/XCEngine/Audio/Equalizer/SetBandGain.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Equalizer::SetBandGain
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetBandGain(uint32 band, float gainDb);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
- `gainDb` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandGain(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
32
docs/api/XCEngine/Audio/Equalizer/SetBandQ.md
Normal file
32
docs/api/XCEngine/Audio/Equalizer/SetBandQ.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Equalizer::SetBandQ
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetBandQ(uint32 band, float q);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
- `q` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandQ(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/Equalizer/SetEnabled.md
Normal file
31
docs/api/XCEngine/Audio/Equalizer/SetEnabled.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Equalizer::SetEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetEnabled(bool enabled) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/Equalizer/SetWetMix.md
Normal file
31
docs/api/XCEngine/Audio/Equalizer/SetWetMix.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Equalizer::SetWetMix
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetWetMix(float wetMix) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `wetMix` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetWetMix(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
41
docs/api/XCEngine/Audio/FFTFilter/Constructor.md
Normal file
41
docs/api/XCEngine/Audio/FFTFilter/Constructor.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# FFTFilter::FFTFilter()
|
||||
|
||||
构造对象。
|
||||
|
||||
该方法在 `XCEngine/Audio/FFTFilter.h` 中提供了 2 个重载,当前页面统一汇总这些公开声明。
|
||||
|
||||
## 重载 1: 声明
|
||||
|
||||
```cpp
|
||||
FFTFilter();
|
||||
```
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
explicit FFTFilter(uint32 fftSize);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `fftSize` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
29
docs/api/XCEngine/Audio/FFTFilter/Destructor.md
Normal file
29
docs/api/XCEngine/Audio/FFTFilter/Destructor.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# FFTFilter::~FFTFilter()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
|
||||
```cpp
|
||||
~FFTFilter() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
38
docs/api/XCEngine/Audio/FFTFilter/FFTFilter.md
Normal file
38
docs/api/XCEngine/Audio/FFTFilter/FFTFilter.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# FFTFilter
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `FFTFilter` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`FFTFilter.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `FFTFilter` | `class` | 继承自 `IAudioEffect` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [FFTFilter()](Constructor.md) | 构造对象。 |
|
||||
| [~FFTFilter()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetFFTSize](SetFFTSize.md) | 设置相关状态或配置。 |
|
||||
| [GetFFTSize](GetFFTSize.md) | 获取相关状态或对象。 |
|
||||
| [SetSmoothingFactor](SetSmoothingFactor.md) | 设置相关状态或配置。 |
|
||||
| [GetSmoothingFactor](GetSmoothingFactor.md) | 获取相关状态或对象。 |
|
||||
| [GetSpectrumData](GetSpectrumData.md) | 获取相关状态或对象。 |
|
||||
| [GetSpectrumSize](GetSpectrumSize.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
30
docs/api/XCEngine/Audio/FFTFilter/GetFFTSize.md
Normal file
30
docs/api/XCEngine/Audio/FFTFilter/GetFFTSize.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# FFTFilter::GetFFTSize
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
uint32 GetFFTSize() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `uint32` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetFFTSize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/FFTFilter/GetSmoothingFactor.md
Normal file
30
docs/api/XCEngine/Audio/FFTFilter/GetSmoothingFactor.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# FFTFilter::GetSmoothingFactor
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetSmoothingFactor() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetSmoothingFactor(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/FFTFilter/GetSpectrumData.md
Normal file
30
docs/api/XCEngine/Audio/FFTFilter/GetSpectrumData.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# FFTFilter::GetSpectrumData
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const float* GetSpectrumData() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const float*` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetSpectrumData(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/FFTFilter/GetSpectrumSize.md
Normal file
30
docs/api/XCEngine/Audio/FFTFilter/GetSpectrumSize.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# FFTFilter::GetSpectrumSize
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
size_t GetSpectrumSize() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `size_t` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetSpectrumSize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
33
docs/api/XCEngine/Audio/FFTFilter/ProcessAudio.md
Normal file
33
docs/api/XCEngine/Audio/FFTFilter/ProcessAudio.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# FFTFilter::ProcessAudio
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/FFTFilter/SetFFTSize.md
Normal file
31
docs/api/XCEngine/Audio/FFTFilter/SetFFTSize.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# FFTFilter::SetFFTSize
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetFFTSize(uint32 size);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `size` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::SetFFTSize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/FFTFilter/SetSmoothingFactor.md
Normal file
31
docs/api/XCEngine/Audio/FFTFilter/SetSmoothingFactor.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# FFTFilter::SetSmoothingFactor
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetSmoothingFactor(float factor);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`,当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `factor` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::SetSmoothingFactor(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
28
docs/api/XCEngine/Audio/HRTF/Constructor.md
Normal file
28
docs/api/XCEngine/Audio/HRTF/Constructor.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# HRTF::HRTF()
|
||||
|
||||
构造对象。
|
||||
|
||||
```cpp
|
||||
HRTF();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
29
docs/api/XCEngine/Audio/HRTF/Destructor.md
Normal file
29
docs/api/XCEngine/Audio/HRTF/Destructor.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# HRTF::~HRTF()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
|
||||
```cpp
|
||||
~HRTF();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/HRTF/GetCrossFeed.md
Normal file
30
docs/api/XCEngine/Audio/HRTF/GetCrossFeed.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HRTF::GetCrossFeed
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetCrossFeed() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::GetCrossFeed(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/HRTF/GetQualityLevel.md
Normal file
30
docs/api/XCEngine/Audio/HRTF/GetQualityLevel.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HRTF::GetQualityLevel
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
uint32 GetQualityLevel() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `uint32` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::GetQualityLevel(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/HRTF/GetSpeedOfSound.md
Normal file
30
docs/api/XCEngine/Audio/HRTF/GetSpeedOfSound.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HRTF::GetSpeedOfSound
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
float GetSpeedOfSound() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::GetSpeedOfSound(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
45
docs/api/XCEngine/Audio/HRTF/HRTF.md
Normal file
45
docs/api/XCEngine/Audio/HRTF/HRTF.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# HRTF
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `HRTF` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`HRTF.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `HRTFParams` | `struct` | 头文件中的公开声明。 |
|
||||
| `HRTF` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [HRTF()](Constructor.md) | 构造对象。 |
|
||||
| [~HRTF()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetEnabled](SetEnabled.md) | 设置相关状态或配置。 |
|
||||
| [IsEnabled](IsEnabled.md) | 查询当前状态。 |
|
||||
| [SetHRTFEnabled](SetHRTFEnabled.md) | 设置相关状态或配置。 |
|
||||
| [IsHRTFEnabled](IsHRTFEnabled.md) | 查询当前状态。 |
|
||||
| [SetQualityLevel](SetQualityLevel.md) | 设置相关状态或配置。 |
|
||||
| [GetQualityLevel](GetQualityLevel.md) | 获取相关状态或对象。 |
|
||||
| [SetCrossFeed](SetCrossFeed.md) | 设置相关状态或配置。 |
|
||||
| [GetCrossFeed](GetCrossFeed.md) | 获取相关状态或对象。 |
|
||||
| [SetDopplerShiftEnabled](SetDopplerShiftEnabled.md) | 设置相关状态或配置。 |
|
||||
| [IsDopplerShiftEnabled](IsDopplerShiftEnabled.md) | 查询当前状态。 |
|
||||
| [SetSpeedOfSound](SetSpeedOfSound.md) | 设置相关状态或配置。 |
|
||||
| [GetSpeedOfSound](GetSpeedOfSound.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
30
docs/api/XCEngine/Audio/HRTF/IsDopplerShiftEnabled.md
Normal file
30
docs/api/XCEngine/Audio/HRTF/IsDopplerShiftEnabled.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HRTF::IsDopplerShiftEnabled
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
bool IsDopplerShiftEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::IsDopplerShiftEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/HRTF/IsEnabled.md
Normal file
30
docs/api/XCEngine/Audio/HRTF/IsEnabled.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HRTF::IsEnabled
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
bool IsEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::IsEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/HRTF/IsHRTFEnabled.md
Normal file
30
docs/api/XCEngine/Audio/HRTF/IsHRTFEnabled.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HRTF::IsHRTFEnabled
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
bool IsHRTFEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::IsHRTFEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
36
docs/api/XCEngine/Audio/HRTF/ProcessAudio.md
Normal file
36
docs/api/XCEngine/Audio/HRTF/ProcessAudio.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# HRTF::ProcessAudio
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels, const Math::Vector3& sourcePosition, const Math::Vector3& listenerPosition, const Math::Quaternion& listenerRotation);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
- `sourcePosition` - 参数语义详见头文件声明。
|
||||
- `listenerPosition` - 参数语义详见头文件声明。
|
||||
- `listenerRotation` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/HRTF/SetCrossFeed.md
Normal file
31
docs/api/XCEngine/Audio/HRTF/SetCrossFeed.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# HRTF::SetCrossFeed
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetCrossFeed(float crossFeed);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `crossFeed` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetCrossFeed(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/HRTF/SetDopplerShiftEnabled.md
Normal file
31
docs/api/XCEngine/Audio/HRTF/SetDopplerShiftEnabled.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# HRTF::SetDopplerShiftEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetDopplerShiftEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetDopplerShiftEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/HRTF/SetEnabled.md
Normal file
31
docs/api/XCEngine/Audio/HRTF/SetEnabled.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# HRTF::SetEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/HRTF/SetHRTFEnabled.md
Normal file
31
docs/api/XCEngine/Audio/HRTF/SetHRTFEnabled.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# HRTF::SetHRTFEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetHRTFEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetHRTFEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/HRTF/SetQualityLevel.md
Normal file
31
docs/api/XCEngine/Audio/HRTF/SetQualityLevel.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# HRTF::SetQualityLevel
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetQualityLevel(uint32 level);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `level` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetQualityLevel(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/HRTF/SetSpeedOfSound.md
Normal file
31
docs/api/XCEngine/Audio/HRTF/SetSpeedOfSound.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# HRTF::SetSpeedOfSound
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetSpeedOfSound(float speed);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`,当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `speed` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetSpeedOfSound(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
29
docs/api/XCEngine/Audio/IAudioBackend/Destructor.md
Normal file
29
docs/api/XCEngine/Audio/IAudioBackend/Destructor.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# IAudioBackend::~IAudioBackend()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
|
||||
```cpp
|
||||
virtual ~IAudioBackend() = default;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/IAudioBackend/GetAvailableDevices.md
Normal file
31
docs/api/XCEngine/Audio/IAudioBackend/GetAvailableDevices.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# IAudioBackend::GetAvailableDevices
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
virtual void GetAvailableDevices(std::vector<std::string>& devices) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `devices` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::GetAvailableDevices(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/GetConfig.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/GetConfig.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::GetConfig
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
virtual AudioConfig GetConfig() const = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `AudioConfig` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::GetConfig(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/GetDeviceName.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/GetDeviceName.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::GetDeviceName
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
virtual std::string GetDeviceName() const = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `std::string` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::GetDeviceName(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/GetMasterVolume.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/GetMasterVolume.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::GetMasterVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
virtual float GetMasterVolume() const = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::GetMasterVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
46
docs/api/XCEngine/Audio/IAudioBackend/IAudioBackend.md
Normal file
46
docs/api/XCEngine/Audio/IAudioBackend/IAudioBackend.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# IAudioBackend
|
||||
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `class (abstract)`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Audio` 子目录中的 `IAudioBackend` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`IAudioBackend.h` 是 `XCEngine/Audio` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `IAudioBackend` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [~IAudioBackend()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Initialize](Initialize.md) | 初始化内部状态。 |
|
||||
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
|
||||
| [GetDeviceName](GetDeviceName.md) | 获取相关状态或对象。 |
|
||||
| [GetAvailableDevices](GetAvailableDevices.md) | 获取相关状态或对象。 |
|
||||
| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
|
||||
| [GetMasterVolume](GetMasterVolume.md) | 获取相关状态或对象。 |
|
||||
| [SetMasterVolume](SetMasterVolume.md) | 设置相关状态或配置。 |
|
||||
| [IsMuted](IsMuted.md) | 查询当前状态。 |
|
||||
| [SetMuted](SetMuted.md) | 设置相关状态或配置。 |
|
||||
| [Start](Start.md) | 公开方法,详见头文件声明。 |
|
||||
| [Stop](Stop.md) | 公开方法,详见头文件声明。 |
|
||||
| [Suspend](Suspend.md) | 公开方法,详见头文件声明。 |
|
||||
| [Resume](Resume.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [IsRunning](IsRunning.md) | 查询当前状态。 |
|
||||
| [GetConfig](GetConfig.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
31
docs/api/XCEngine/Audio/IAudioBackend/Initialize.md
Normal file
31
docs/api/XCEngine/Audio/IAudioBackend/Initialize.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# IAudioBackend::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
|
||||
```cpp
|
||||
virtual bool Initialize(const AudioConfig& config) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `config` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/IsMuted.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/IsMuted.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::IsMuted
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
virtual bool IsMuted() const = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::IsMuted(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/IsRunning.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/IsRunning.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::IsRunning
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
virtual bool IsRunning() const = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::IsRunning(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
34
docs/api/XCEngine/Audio/IAudioBackend/ProcessAudio.md
Normal file
34
docs/api/XCEngine/Audio/IAudioBackend/ProcessAudio.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# IAudioBackend::ProcessAudio
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
virtual void ProcessAudio(float* buffer, uint32 bufferSize, uint32 channels, uint32 sampleRate) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `bufferSize` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
- `sampleRate` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/Resume.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/Resume.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::Resume
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
virtual void Resume() = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::Resume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/IAudioBackend/SetDevice.md
Normal file
31
docs/api/XCEngine/Audio/IAudioBackend/SetDevice.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# IAudioBackend::SetDevice
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
virtual bool SetDevice(const std::string& deviceName) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `deviceName` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::SetDevice(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/IAudioBackend/SetMasterVolume.md
Normal file
31
docs/api/XCEngine/Audio/IAudioBackend/SetMasterVolume.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# IAudioBackend::SetMasterVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
virtual void SetMasterVolume(float volume) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::SetMasterVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
31
docs/api/XCEngine/Audio/IAudioBackend/SetMuted.md
Normal file
31
docs/api/XCEngine/Audio/IAudioBackend/SetMuted.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# IAudioBackend::SetMuted
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
virtual void SetMuted(bool muted) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `muted` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::SetMuted(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
30
docs/api/XCEngine/Audio/IAudioBackend/Shutdown.md
Normal file
30
docs/api/XCEngine/Audio/IAudioBackend/Shutdown.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# IAudioBackend::Shutdown
|
||||
|
||||
关闭并清理内部状态。
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`,当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::Shutdown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user