docs: sync api and planning docs
This commit is contained in:
@@ -1,31 +1,26 @@
|
||||
# AudioMixer::AddEffect
|
||||
|
||||
添加元素或建立关联。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void AddEffect(IAudioEffect* effect);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `effect` - 参数语义详见头文件声明。
|
||||
更新 `m_effects`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::AddEffect(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_effects`。
|
||||
- 当前实现会调用 `push_back`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioMixer::ClearEffects
|
||||
|
||||
清空内部数据。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void ClearEffects();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
更新 `m_effects`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::ClearEffects(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_effects`。
|
||||
- 当前实现会调用 `clear`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,28 +1,25 @@
|
||||
# AudioMixer::AudioMixer()
|
||||
|
||||
构造对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,29 +1,25 @@
|
||||
# AudioMixer::~AudioMixer()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioMixer::Get3DParams
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const Audio3DParams& Get3DParams() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_3DParams`。
|
||||
|
||||
**返回：** `const Audio3DParams&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::Get3DParams(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_3DParams`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [Set3DParams](Set3DParams.md)
|
||||
|
||||
@@ -1,31 +1,28 @@
|
||||
# AudioMixer::GetChannelVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetChannelVolume(AudioChannel channel) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `channel` - 参数语义详见头文件声明。
|
||||
更新 `m_channelVolumes`。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::GetChannelVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_channelVolumes`。
|
||||
- 当前实现会调用 `find`、`end`。
|
||||
- 包含条件分支，并可能提前返回。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [SetChannelVolume](SetChannelVolume.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioMixer::GetOutputMixer
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
AudioMixer* GetOutputMixer() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_outputMixer` 当前值。
|
||||
|
||||
**返回：** `AudioMixer*` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::GetOutputMixer(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_outputMixer` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [SetOutputMixer](SetOutputMixer.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioMixer::GetVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetVolume() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_volume` 当前值。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::GetVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_volume` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [SetVolume](SetVolume.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# AudioMixer::IsMute
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool IsMute() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_mute` 当前值。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::IsMute(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_mute` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,33 +1,25 @@
|
||||
# AudioMixer::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioMixer::RemoveEffect
|
||||
|
||||
移除元素或解除关联。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void RemoveEffect(IAudioEffect* effect);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `effect` - 参数语义详见头文件声明。
|
||||
更新 `m_effects`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::RemoveEffect(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_effects`。
|
||||
- 当前实现会调用 `find`、`begin`、`end`、`erase`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioMixer::Set3DParams
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [Get3DParams](Get3DParams.md)
|
||||
|
||||
@@ -1,32 +1,27 @@
|
||||
# AudioMixer::SetChannelVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetChannelVolume(AudioChannel channel, float volume);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `channel` - 参数语义详见头文件声明。
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
更新 `m_channelVolumes`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetChannelVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_channelVolumes`。
|
||||
- 当前实现会调用 `find`、`end`、`max`、`min`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [GetChannelVolume](GetChannelVolume.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# AudioMixer::SetMute
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetMute(bool mute);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `mute` - 参数语义详见头文件声明。
|
||||
更新 `m_mute`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetMute(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_mute`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioMixer::SetOutputMixer
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetOutputMixer(AudioMixer* mixer);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `mixer` - 参数语义详见头文件声明。
|
||||
更新 `m_outputMixer`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetOutputMixer(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_outputMixer`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [GetOutputMixer](GetOutputMixer.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# AudioMixer::SetVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioMixer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetVolume(float volume);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
更新 `m_volume`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioMixer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioMixer object;
|
||||
// 根据上下文补齐参数后调用 AudioMixer::SetVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_volume`。
|
||||
- 当前实现会调用 `max`、`min`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioMixer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioMixer](AudioMixer.md)
|
||||
- [GetVolume](GetVolume.md)
|
||||
|
||||
@@ -1,29 +1,25 @@
|
||||
# AudioSystem::Get
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
static AudioSystem& Get();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `instance`。
|
||||
|
||||
**返回：** `AudioSystem&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
auto& instance = XCEngine::Audio::AudioSystem::Get();
|
||||
(void)instance;
|
||||
}
|
||||
```
|
||||
- 返回 `instance`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# AudioSystem::GetAvailableDevices
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void GetAvailableDevices(std::vector<std::string>& devices);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `devices` - 参数语义详见头文件声明。
|
||||
执行 `GetAvailableDevices` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetAvailableDevices(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `GetAvailableDevices`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,30 +1,27 @@
|
||||
# AudioSystem::GetBackend
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
IAudioBackend* GetBackend() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
更新 `m_backend`。
|
||||
|
||||
**返回：** `IAudioBackend*` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetBackend(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_backend`。
|
||||
- 当前实现会调用 `get`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
- [SetBackend](SetBackend.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioSystem::GetCurrentDevice
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
std::string GetCurrentDevice() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
执行 `GetDeviceName` 协同流程。
|
||||
|
||||
**返回：** `std::string` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetCurrentDevice(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `GetDeviceName`。
|
||||
- 包含条件分支，并可能提前返回。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# AudioSystem::GetListenerPosition
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const Math::Vector3& GetListenerPosition() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_listenerPosition` 当前值。
|
||||
|
||||
**返回：** `const Math::Vector3&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetListenerPosition(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_listenerPosition` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# AudioSystem::GetListenerRotation
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const Math::Quaternion& GetListenerRotation() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_listenerRotation` 当前值。
|
||||
|
||||
**返回：** `const Math::Quaternion&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetListenerRotation(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_listenerRotation` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioSystem::GetListenerVelocity
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const Math::Vector3& GetListenerVelocity() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_listenerVelocity` 当前值。
|
||||
|
||||
**返回：** `const Math::Vector3&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetListenerVelocity(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_listenerVelocity` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
- [SetListenerVelocity](SetListenerVelocity.md)
|
||||
|
||||
@@ -1,30 +1,27 @@
|
||||
# AudioSystem::GetMasterVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetMasterVolume() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
执行 `GetMasterVolume` 协同流程。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetMasterVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `GetMasterVolume`。
|
||||
- 包含条件分支，并可能提前返回。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
- [SetMasterVolume](SetMasterVolume.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# AudioSystem::GetStats
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const Stats& GetStats() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_stats` 当前值。
|
||||
|
||||
**返回：** `const Stats&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::GetStats(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_stats` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioSystem::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void Initialize(const AudioConfig& config);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `config` - 参数语义详见头文件声明。
|
||||
更新 `m_backend`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_backend`。
|
||||
- 当前实现会调用 `Shutdown`、`Initialize`、`Start`、`reset`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# AudioSystem::IsMuted
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool IsMuted() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
执行 `IsMuted` 协同流程。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::IsMuted(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `IsMuted`。
|
||||
- 包含条件分支，并可能提前返回。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,33 +1,25 @@
|
||||
# AudioSystem::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
执行 `ProcessAudio` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `ProcessAudio`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioSystem::RegisterSource
|
||||
|
||||
注册对象、回调或映射。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void RegisterSource(Components::AudioSourceComponent* source);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `source` - 参数语义详见头文件声明。
|
||||
更新 `m_activeSources`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::RegisterSource(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_activeSources`。
|
||||
- 当前实现会调用 `push_back`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# AudioSystem::SetBackend
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetBackend(std::unique_ptr<IAudioBackend> backend);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `backend` - 参数语义详见头文件声明。
|
||||
更新 `m_backend`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetBackend(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_backend`。
|
||||
- 当前实现会调用 `move`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
- [GetBackend](GetBackend.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# AudioSystem::SetDevice
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetDevice(const std::string& deviceName);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `deviceName` - 参数语义详见头文件声明。
|
||||
执行 `SetDevice` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetDevice(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `SetDevice`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,32 +1,25 @@
|
||||
# AudioSystem::SetListenerTransform
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_listenerPosition`、`m_listenerRotation`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioSystem::SetListenerVelocity
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetListenerVelocity(const Math::Vector3& velocity);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `velocity` - 参数语义详见头文件声明。
|
||||
更新 `m_listenerVelocity`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetListenerVelocity(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_listenerVelocity`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
- [GetListenerVelocity](GetListenerVelocity.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioSystem::SetMasterVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetMasterVolume(float volume);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `volume` - 参数语义详见头文件声明。
|
||||
执行 `SetMasterVolume` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetMasterVolume(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `SetMasterVolume`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
- [GetMasterVolume](GetMasterVolume.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# AudioSystem::SetMuted
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetMuted(bool muted);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `muted` - 参数语义详见头文件声明。
|
||||
执行 `SetMuted` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::SetMuted(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `SetMuted`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# AudioSystem::Shutdown
|
||||
|
||||
关闭并清理内部状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
执行 `Stop`、`Shutdown`、`reset` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::Shutdown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `Stop`、`Shutdown`、`reset`、`clear`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioSystem::UnregisterSource
|
||||
|
||||
取消注册对象、回调或映射。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void UnregisterSource(Components::AudioSourceComponent* source);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `source` - 参数语义详见头文件声明。
|
||||
更新 `m_activeSources`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::UnregisterSource(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_activeSources`。
|
||||
- 当前实现会调用 `find`、`begin`、`end`、`erase`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# AudioSystem::Update
|
||||
|
||||
更新运行时状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/AudioSystem.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void Update(float deltaTime);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `deltaTime` - 参数语义详见头文件声明。
|
||||
更新 `m_deltaTime`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::AudioSystem object;
|
||||
// 根据上下文补齐参数后调用 AudioSystem::Update(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_deltaTime`。
|
||||
- 当前实现会调用 `IsRunning`、`GetConfig`、`mixBuffer`、`IsEnabled`、`IsPlaying`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](AudioSystem.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [AudioSystem](AudioSystem.md)
|
||||
|
||||
@@ -1,28 +1,25 @@
|
||||
# Equalizer::Equalizer()
|
||||
|
||||
构造对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
Equalizer();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
构造 `Equalizer` 实例。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
}
|
||||
```
|
||||
- 具体定义位于 `engine/src/Audio/Equalizer.cpp`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
|
||||
@@ -1,29 +1,25 @@
|
||||
# Equalizer::~Equalizer()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [Equalizer](Equalizer.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# Equalizer::GetBandCount
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
uint32 GetBandCount() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_bandCount` 当前值。
|
||||
|
||||
**返回：** `uint32` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetBandCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_bandCount` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [SetBandCount](SetBandCount.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# Equalizer::GetBandFrequency
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [SetBandFrequency](SetBandFrequency.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# Equalizer::GetBandGain
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [SetBandGain](SetBandGain.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# Equalizer::GetBandQ
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [SetBandQ](SetBandQ.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# Equalizer::GetWetMix
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetWetMix() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_wetMix` 当前值。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetWetMix(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_wetMix` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [SetWetMix](SetWetMix.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# Equalizer::IsEnabled
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool IsEnabled() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_enabled` 当前值。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::IsEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_enabled` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
|
||||
@@ -1,33 +1,25 @@
|
||||
# Equalizer::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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;
|
||||
}
|
||||
```
|
||||
- 包含 `nullptr` 相关分支。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# Equalizer::SetBandCount
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetBandCount(uint32 count);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `count` - 参数语义详见头文件声明。
|
||||
更新 `m_bandCount`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_bandCount`。
|
||||
- 当前实现会调用 `resize`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [GetBandCount](GetBandCount.md)
|
||||
|
||||
@@ -1,32 +1,26 @@
|
||||
# Equalizer::SetBandFrequency
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetBandFrequency(uint32 band, float frequency);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
- `frequency` - 参数语义详见头文件声明。
|
||||
执行 `max`、`min`、`ComputeCoefficients` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandFrequency(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `max`、`min`、`ComputeCoefficients`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [GetBandFrequency](GetBandFrequency.md)
|
||||
|
||||
@@ -1,32 +1,26 @@
|
||||
# Equalizer::SetBandGain
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetBandGain(uint32 band, float gainDb);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
- `gainDb` - 参数语义详见头文件声明。
|
||||
执行 `max`、`min`、`ComputeCoefficients` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandGain(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `max`、`min`、`ComputeCoefficients`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [GetBandGain](GetBandGain.md)
|
||||
|
||||
@@ -1,32 +1,26 @@
|
||||
# Equalizer::SetBandQ
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetBandQ(uint32 band, float q);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `band` - 参数语义详见头文件声明。
|
||||
- `q` - 参数语义详见头文件声明。
|
||||
执行 `max`、`min`、`ComputeCoefficients` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetBandQ(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `max`、`min`、`ComputeCoefficients`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [GetBandQ](GetBandQ.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# Equalizer::SetEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetEnabled(bool enabled) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
更新 `m_enabled`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_enabled`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# Equalizer::SetWetMix
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/Equalizer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetWetMix(float wetMix) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `wetMix` - 参数语义详见头文件声明。
|
||||
更新 `m_wetMix`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::SetWetMix(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_wetMix`。
|
||||
- 当前实现会调用 `max`、`min`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [Equalizer](Equalizer.md)
|
||||
- [GetWetMix](GetWetMix.md)
|
||||
|
||||
@@ -1,41 +1,26 @@
|
||||
# FFTFilter::FFTFilter()
|
||||
|
||||
构造对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
该方法在 `XCEngine/Audio/FFTFilter.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
|
||||
**类型**: `method`
|
||||
|
||||
## 重载 1: 声明
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
FFTFilter();
|
||||
```
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
explicit FFTFilter(uint32 fftSize);
|
||||
```
|
||||
|
||||
**参数：**
|
||||
- `fftSize` - 参数语义详见头文件声明。
|
||||
## 作用
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
构造 `FFTFilter` 实例。
|
||||
|
||||
**示例：**
|
||||
## 当前实现
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
}
|
||||
```
|
||||
- 具体定义位于 `engine/src/Audio/FFTFilter.cpp`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
|
||||
@@ -1,29 +1,27 @@
|
||||
# FFTFilter::~FFTFilter()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
~FFTFilter() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
执行 `kiss_fft_free`、`kiss_fftr_free` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
- 会更新 `m_fftConfig`、`m_fftrConfig`。
|
||||
- 当前实现会调用 `kiss_fft_free`、`kiss_fftr_free`。
|
||||
- 包含 `nullptr` 相关分支。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# FFTFilter::GetFFTSize
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
uint32 GetFFTSize() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_fftSize` 当前值。
|
||||
|
||||
**返回：** `uint32` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetFFTSize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_fftSize` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
- [SetFFTSize](SetFFTSize.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# FFTFilter::GetSmoothingFactor
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetSmoothingFactor() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_smoothingFactor` 当前值。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetSmoothingFactor(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_smoothingFactor` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
- [SetSmoothingFactor](SetSmoothingFactor.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# FFTFilter::GetSpectrumData
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const float* GetSpectrumData() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
更新 `m_spectrumData`。
|
||||
|
||||
**返回：** `const float*` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetSpectrumData(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_spectrumData`。
|
||||
- 当前实现会调用 `data`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# FFTFilter::GetSpectrumSize
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
size_t GetSpectrumSize() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
更新 `m_spectrumData`。
|
||||
|
||||
**返回：** `size_t` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::GetSpectrumSize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_spectrumData`。
|
||||
- 当前实现会调用 `size`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
|
||||
@@ -1,33 +1,26 @@
|
||||
# FFTFilter::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
执行 `size`、`resize` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `size`、`resize`、`monoBuffer`、`ComputeFFT`。
|
||||
- 包含 `nullptr` 相关分支。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# FFTFilter::SetFFTSize
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetFFTSize(uint32 size);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `size` - 参数语义详见头文件声明。
|
||||
更新 `m_fftSize`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::SetFFTSize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_fftSize`。
|
||||
- 当前实现会调用 `resize`、`InitializeFFT`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
- [GetFFTSize](GetFFTSize.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# FFTFilter::SetSmoothingFactor
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/FFTFilter.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetSmoothingFactor(float factor);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `factor` - 参数语义详见头文件声明。
|
||||
更新 `m_smoothingFactor`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/FFTFilter.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::FFTFilter object;
|
||||
// 根据上下文补齐参数后调用 FFTFilter::SetSmoothingFactor(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_smoothingFactor`。
|
||||
- 当前实现会调用 `max`、`min`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FFTFilter.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [FFTFilter](FFTFilter.md)
|
||||
- [GetSmoothingFactor](GetSmoothingFactor.md)
|
||||
|
||||
@@ -1,28 +1,25 @@
|
||||
# HRTF::HRTF()
|
||||
|
||||
构造对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
HRTF();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
构造 `HRTF` 实例。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
}
|
||||
```
|
||||
- 具体定义位于 `engine/src/Audio/HRTF.cpp`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,29 +1,25 @@
|
||||
# HRTF::~HRTF()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# HRTF::GetCrossFeed
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetCrossFeed() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_crossFeed` 当前值。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::GetCrossFeed(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_crossFeed` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
- [SetCrossFeed](SetCrossFeed.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# HRTF::GetQualityLevel
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
uint32 GetQualityLevel() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_qualityLevel` 当前值。
|
||||
|
||||
**返回：** `uint32` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::GetQualityLevel(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_qualityLevel` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
- [SetQualityLevel](SetQualityLevel.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# HRTF::GetSpeedOfSound
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
float GetSpeedOfSound() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_speedOfSound` 当前值。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::GetSpeedOfSound(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_speedOfSound` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
- [SetSpeedOfSound](SetSpeedOfSound.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# HRTF::IsDopplerShiftEnabled
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool IsDopplerShiftEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_dopplerEnabled` 当前值。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::IsDopplerShiftEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_dopplerEnabled` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# HRTF::IsEnabled
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool IsEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_enabled` 当前值。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::IsEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_enabled` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# HRTF::IsHRTFEnabled
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool IsHRTFEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_hrtfEnabled` 当前值。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::IsHRTFEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_hrtfEnabled` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,36 +1,26 @@
|
||||
# HRTF::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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` - 参数语义详见头文件声明。
|
||||
执行 `ComputeDirection`、`ComputeITD`、`ComputeILD` 协同流程。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 当前实现会调用 `ComputeDirection`、`ComputeITD`、`ComputeILD`、`ApplyHRTF`、`ApplySimplePanning`。
|
||||
- 包含 `nullptr` 相关分支。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# HRTF::SetCrossFeed
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetCrossFeed(float crossFeed);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `crossFeed` - 参数语义详见头文件声明。
|
||||
更新 `m_crossFeed`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetCrossFeed(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_crossFeed`。
|
||||
- 当前实现会调用 `max`、`min`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
- [GetCrossFeed](GetCrossFeed.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# HRTF::SetDopplerShiftEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetDopplerShiftEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
更新 `m_dopplerEnabled`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetDopplerShiftEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_dopplerEnabled`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# HRTF::SetEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
更新 `m_enabled`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_enabled`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# HRTF::SetHRTFEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetHRTFEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
更新 `m_hrtfEnabled`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetHRTFEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_hrtfEnabled`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# HRTF::SetQualityLevel
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetQualityLevel(uint32 level);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `level` - 参数语义详见头文件声明。
|
||||
更新 `m_qualityLevel`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetQualityLevel(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_qualityLevel`。
|
||||
- 当前实现会调用 `max`、`min`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
- [GetQualityLevel](GetQualityLevel.md)
|
||||
|
||||
@@ -1,31 +1,27 @@
|
||||
# HRTF::SetSpeedOfSound
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/HRTF.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetSpeedOfSound(float speed);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `speed` - 参数语义详见头文件声明。
|
||||
更新 `m_speedOfSound`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/HRTF.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::HRTF object;
|
||||
// 根据上下文补齐参数后调用 HRTF::SetSpeedOfSound(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_speedOfSound`。
|
||||
- 当前实现会调用 `max`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](HRTF.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [HRTF](HRTF.md)
|
||||
- [GetSpeedOfSound](GetSpeedOfSound.md)
|
||||
|
||||
@@ -1,29 +1,25 @@
|
||||
# IAudioBackend::~IAudioBackend()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual ~IAudioBackend() = default;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
销毁 `IAudioBackend` 实例。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
- 当前为默认析构实现。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# IAudioBackend::GetAvailableDevices
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::GetConfig
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::GetDeviceName
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# IAudioBackend::GetMasterVolume
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
- [SetMasterVolume](SetMasterVolume.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# IAudioBackend::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::IsMuted
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::IsRunning
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,34 +1,25 @@
|
||||
# IAudioBackend::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::Resume
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# IAudioBackend::SetDevice
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# IAudioBackend::SetMasterVolume
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
- [GetMasterVolume](GetMasterVolume.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# IAudioBackend::SetMuted
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::Shutdown
|
||||
|
||||
关闭并清理内部状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```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)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::Start
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual void Start() = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
纯虚接口。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::Start(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 该声明是纯虚接口，基类不提供实现。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::Stop
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual void Stop() = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
纯虚接口。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::Stop(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 该声明是纯虚接口，基类不提供实现。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioBackend::Suspend
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioBackend.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual void Suspend() = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
纯虚接口。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioBackend.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioBackend object;
|
||||
// 根据上下文补齐参数后调用 IAudioBackend::Suspend(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 该声明是纯虚接口，基类不提供实现。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioBackend.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioBackend](IAudioBackend.md)
|
||||
|
||||
@@ -1,29 +1,25 @@
|
||||
# IAudioEffect::~IAudioEffect()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual ~IAudioEffect() = default;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioEffect.h`，当前页面用于固定 `IAudioEffect` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
销毁 `IAudioEffect` 实例。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioEffect.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioEffect object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
- 当前为默认析构实现。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioEffect.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioEffect](IAudioEffect.md)
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
# IAudioEffect::GetWetMix
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual float GetWetMix() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioEffect.h`，当前页面用于固定 `IAudioEffect` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_wetMix` 当前值。
|
||||
|
||||
**返回：** `float` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioEffect.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioEffect object;
|
||||
// 根据上下文补齐参数后调用 IAudioEffect::GetWetMix(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_wetMix` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioEffect.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioEffect](IAudioEffect.md)
|
||||
- [SetWetMix](SetWetMix.md)
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# IAudioEffect::IsEnabled
|
||||
|
||||
查询当前状态。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual bool IsEnabled() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioEffect.h`，当前页面用于固定 `IAudioEffect` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：** 无。
|
||||
返回 `m_enabled` 当前值。
|
||||
|
||||
**返回：** `bool` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioEffect.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioEffect object;
|
||||
// 根据上下文补齐参数后调用 IAudioEffect::IsEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_enabled` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioEffect.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioEffect](IAudioEffect.md)
|
||||
|
||||
@@ -1,33 +1,25 @@
|
||||
# IAudioEffect::ProcessAudio
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels) = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioEffect.h`，当前页面用于固定 `IAudioEffect` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `buffer` - 参数语义详见头文件声明。
|
||||
- `sampleCount` - 参数语义详见头文件声明。
|
||||
- `channels` - 参数语义详见头文件声明。
|
||||
纯虚接口。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioEffect.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioEffect object;
|
||||
// 根据上下文补齐参数后调用 IAudioEffect::ProcessAudio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 该声明是纯虚接口，基类不提供实现。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioEffect.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioEffect](IAudioEffect.md)
|
||||
|
||||
@@ -1,31 +1,25 @@
|
||||
# IAudioEffect::SetEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual void SetEnabled(bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioEffect.h`，当前页面用于固定 `IAudioEffect` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
更新 `m_enabled`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioEffect.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioEffect object;
|
||||
// 根据上下文补齐参数后调用 IAudioEffect::SetEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_enabled`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioEffect.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioEffect](IAudioEffect.md)
|
||||
|
||||
@@ -1,31 +1,26 @@
|
||||
# IAudioEffect::SetWetMix
|
||||
|
||||
设置相关状态或配置。
|
||||
**命名空间**: `XCEngine::Audio`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Audio/IAudioEffect.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual void SetWetMix(float wetMix);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/IAudioEffect.h`，当前页面用于固定 `IAudioEffect` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数：**
|
||||
- `wetMix` - 参数语义详见头文件声明。
|
||||
更新 `m_wetMix`。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
## 当前实现
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/IAudioEffect.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::IAudioEffect object;
|
||||
// 根据上下文补齐参数后调用 IAudioEffect::SetWetMix(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 会更新 `m_wetMix`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](IAudioEffect.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
- [IAudioEffect](IAudioEffect.md)
|
||||
- [GetWetMix](GetWetMix.md)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user