@capgo/capacitor-mute/dist/docs.json

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

{
  "api": {
    "name": "MutePlugin",
    "slug": "muteplugin",
    "docs": "Capacitor Mute Plugin for detecting device mute status.",
    "tags": [
      {
        "text": "1.0.0",
        "name": "since"
      }
    ],
    "methods": [
      {
        "name": "isMuted",
        "signature": "() => Promise<MuteResponse>",
        "parameters": [],
        "returns": "Promise<MuteResponse>",
        "tags": [
          {
            "name": "returns",
            "text": "Promise that resolves with the mute status"
          },
          {
            "name": "throws",
            "text": "Error if checking mute status fails"
          },
          {
            "name": "since",
            "text": "1.0.0"
          },
          {
            "name": "example",
            "text": "```typescript\nconst { value } = await Mute.isMuted();\nif (value) {\n  console.log('Device is muted');\n} else {\n  console.log('Device is not muted');\n}\n```"
          }
        ],
        "docs": "Check if the device mute switch is enabled.",
        "complexTypes": [
          "MuteResponse"
        ],
        "slug": "ismuted"
      },
      {
        "name": "getPluginVersion",
        "signature": "() => Promise<{ version: string; }>",
        "parameters": [],
        "returns": "Promise<{ version: string; }>",
        "tags": [
          {
            "name": "returns",
            "text": "Promise that resolves with the plugin version"
          },
          {
            "name": "throws",
            "text": "Error if getting the version fails"
          },
          {
            "name": "since",
            "text": "1.0.0"
          },
          {
            "name": "example",
            "text": "```typescript\nconst { version } = await Mute.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
          }
        ],
        "docs": "Get the native Capacitor plugin version.",
        "complexTypes": [],
        "slug": "getpluginversion"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "MuteResponse",
      "slug": "muteresponse",
      "docs": "Response from mute status check.",
      "tags": [
        {
          "text": "1.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "value",
          "tags": [],
          "docs": "True if device is muted, false otherwise",
          "complexTypes": [],
          "type": "boolean"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}