From 4b7d05d22deb0b97ce2a4a12736efe1b622c13d1 Mon Sep 17 00:00:00 2001 From: ssdfasd <2156608475@qq.com> Date: Thu, 26 Mar 2026 01:55:48 +0800 Subject: [PATCH] refactor(docs): add AudioListenerComponent IsMute method doc --- .../audio-listener-component/is-mute.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/api/components/audio-listener-component/is-mute.md diff --git a/docs/api/components/audio-listener-component/is-mute.md b/docs/api/components/audio-listener-component/is-mute.md new file mode 100644 index 00000000..a5d904cd --- /dev/null +++ b/docs/api/components/audio-listener-component/is-mute.md @@ -0,0 +1,40 @@ +# IsMute + +**所属类**: `AudioListenerComponent` + +**头文件**: `XCEngine/Components/AudioListenerComponent.h` + +**描述**: 检查音频监听器是否处于静音状态。 + +## 函数签名 + +```cpp +bool IsMute() const; +``` + +## 返回值 + +| 类型 | 描述 | +|------|------| +| `bool` | 静音状态,true 表示静音,false 表示非静音 | + +## 使用示例 + +```cpp +#include + +using namespace XCEngine::Components; + +void CheckMuteStatus(AudioListenerComponent* listener) { + if (listener->IsMute()) { + printf("Audio is muted\n"); + } else { + printf("Audio is not muted\n"); + } +} +``` + +## 相关文档 + +- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件 +- [SetMute](./set-mute.md) - 设置静音状态