capacitor-mute

Find out if the device is muted before you play sounds in your Capacitor app, so you can show a visual cue instead of a silent alert.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-mute in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-mute to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• One call: isMuted() returns whether the device is muted.
• iOS: detects the hardware mute switch with AudioToolbox.
• Android: reads the ringer mode from AudioManager.
• Lightweight: no permissions needed.
• Platforms: iOS and Android. Not available on web.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/mute/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-mute
npx cap sync

Know issue

On IOS with Xcode 14 the lib use under the hood Mute is not configured as Apple expect anymore, it's not the only one having the issue as you can see here : https://github.com/CocoaPods/CocoaPods/issues/8891

Solution: Replace this to your Podfile:

post_install do |installer|
  assertDeploymentTarget(installer)
end

By

post_install do |installer|
  assertDeploymentTarget(installer)
  installer.pods_project.targets.each do |target|
    if target.respond_to?(:product_type) and target.product_type == "com.apple.product-type.bundle"
      target.build_configurations.each do |config|
          config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
      end
    end
  end
end

That should solve your issue. I did open issue in the original repo to see if they can fix it: https://github.com/akramhussein/Mute/issues/16 If no answer I will add the code directly to capacitor-mute

API

• isMuted()
• getPluginVersion()
• Interfaces

Capacitor Mute Plugin for detecting device mute status.

isMuted()

isMuted() => Promise<MuteResponse>

Check if the device mute switch is enabled.

Returns: Promise<MuteResponse>

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Interfaces

MuteResponse

Response from mute status check.