refactor api documentation structure
This commit is contained in:
30
docs/api/XCEngine/Audio/Equalizer/GetBandCount.md
Normal file
30
docs/api/XCEngine/Audio/Equalizer/GetBandCount.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Equalizer::GetBandCount
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
uint32 GetBandCount() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Audio/Equalizer.h`,当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `uint32` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/Equalizer.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Audio::Equalizer object;
|
||||
// 根据上下文补齐参数后调用 Equalizer::GetBandCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Equalizer.md)
|
||||
- [返回模块目录](../Audio.md)
|
||||
Reference in New Issue
Block a user