快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-mute` plugin in my project.

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

bun add @capgo/capacitor-mute
bunx cap sync

导入

import { Mute } from '@capgo/capacitor-mute';

快速入门

import { Mute } from '@capgo/capacitor-mute';

const { value } = await Mute.isMuted();
if (value) {
  showVisualAlert();
} else {
  await playNotificationSound();
}

示例：游戏中的门音效

在进入关卡或用户从控制中心返回时轮询静音状态，因为硬件开关的变化不会触发应用事件。

常见坑点

• 不支持 Web: 用 Capacitor 保护 Web 构建 Capacitor.getPlatform() === 'web'.
• 不是音量: mute 反映的是铃声或硬件静音状态，而不是媒体音量滑块。
• Android 模式: 仅振动或静音模式在提示音方面仍视为静音。

API 概览

isMuted

检查设备静音开关是否已开启。

import { Mute } from '@capgo/capacitor-mute';

const { value } = await Mute.isMuted();
if (value) {
  console.log('Device is muted');
} else {
  console.log('Device is not muted');
}

类型参考

MuteResponse

静音状态检查的响应结果。

export interface MuteResponse {
  /** True if device is muted, false otherwise */
  value: boolean;
}

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-mute 针对“使用 @capgo/capacitor-mute”中的原生能力， API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。