docs: 添加 Audio 模块和 Components 模块 API 文档
- 新增 Audio 模块文档 (54 个文件) - AudioSystem 单例类及 20 个方法页 - AudioMixer 混音器类及 11 个方法页 - IAudioBackend、IAudioEffect 接口 - FFTFilter、Reverbation、Equalizer、HRTF 效果类 - WASAPIBackend Windows 后端 - AudioConfig、Audio3DParams 等结构体 - 9 个枚举类型文档 - 新增 Components 模块文档 (3 个文件) - AudioSourceComponent 音频源组件 - AudioListenerComponent 音频监听器组件 - 更新 docs/api/main.md 添加模块导航
This commit is contained in:
28
docs/api/audio/audio-system/is-muted.md
Normal file
28
docs/api/audio/audio-system/is-muted.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# AudioSystem::IsMuted
|
||||
|
||||
检查是否静音。
|
||||
|
||||
```cpp
|
||||
bool IsMuted() const;
|
||||
```
|
||||
|
||||
**返回:** `bool` - 如果当前处于静音状态则返回 true
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Audio/AudioSystem.h>
|
||||
|
||||
using namespace XCEngine::Audio;
|
||||
|
||||
void CheckMuteState() {
|
||||
if (AudioSystem::Get().IsMuted()) {
|
||||
printf("Audio is muted\n");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [AudioSystem 总览](audio-system.md)
|
||||
- [SetMuted](set-muted.md) - 设置静音状态
|
||||
Reference in New Issue
Block a user