Sitelet https://github.com/Cap-go/capacitor-mute
Skip to content

capacitor-mute

Capgo - Instant updates for Capacitor

Detect if the mute switch is enabled/disabled on a device

Documentation

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

Compatibility

Plugin version Capacitor compatibility Maintained
v8.*.* v8.*.* ✅
v7.*.* v7.*.* On demand
v6.*.* v6.*.* ❌
v5.*.* v5.*.* ❌

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 : CocoaPods/CocoaPods#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: akramhussein/Mute#16 If no answer I will add the code directly to capacitor-mute

API

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.

Prop Type Description
value boolean True if device is muted, false otherwise

About

Capacitor plugin to detect if the mute switch is enabled/disabled on a device

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

16 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages