Skip to content
Capgo - Build, ship, and update Capacitor apps Capgo

@capgo/capacitor-mute

Detect hardware mute and ringer state before playing alert sounds in your Capacitor app.
Get started GitHub

Overview

Section titled “Overview”

Call isMuted() before you fire notification sounds or haptics-only feedback. The plugin reads the iOS mute switch through AudioToolbox and Android ringer mode through AudioManager, with no extra permissions.

Typical fits: chat apps, games, training apps, and any UI that should show a visual cue when audio would be silent.

Platform support

Section titled “Platform support”
PlatformSupportNotes
iOSYesHardware mute switch
AndroidYesRinger mode via AudioManager
WebNoAPI not available in browsers

Core Capabilities

Section titled “Core Capabilities”
  • isMuted - Check if the device mute switch is enabled.

Public API

Section titled “Public API”
MethodDescription
isMutedCheck if the device mute switch is enabled.
getPluginVersionGet the native Capacitor plugin version.

Source Of Truth

Section titled “Source Of Truth”

This reference is synced from src/definitions.ts in capacitor-mute.

Keep going from @capgo/capacitor-mute

Section titled “Keep going from @capgo/capacitor-mute”

If you are using @capgo/capacitor-mute to plan dashboard and API operations, connect it with Using @capgo/capacitor-mute for the native capability in Using @capgo/capacitor-mute, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.