Skip to main content
Back to plugins
@capgo/capacitor-mute
Tutorial
@capgo/capacitor-mute

Mute

Detect device mute switch state for iOS devices to handle audio playback appropriately

Guide

Tutorial on Mute

Using @capgo/capacitor-mute

Capacitor Mute Plugin for detecting device mute status.

Install

bun add @capgo/capacitor-mute
bunx cap sync

What This Plugin Exposes

  • isMuted - Check if the device mute switch is enabled.

Example Usage

isMuted

Check if the device mute switch is enabled.

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');
}

Full Reference

Keep going from Using @capgo/capacitor-mute

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