Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-mute
bunx cap sync

Importer

import { Mute } from '@capgo/capacitor-mute';

Démarrage rapide

import { Mute } from '@capgo/capacitor-mute';

const { value } = await Mute.isMuted();
if (value) {
  showVisualAlert();
} else {
  await playNotificationSound();
}

Exemple : appliquer un gate aux sons d'un jeu

Vérifiez l'état du mode muet lors de l'entrée dans un niveau ou lorsque l'utilisateur revient du Centre de contrôle, car l'interrupteur matériel peut changer sans événement applicatif.

Erreurs courantes

• Pas de support web: protège les builds web Capacitor avec Capacitor.getPlatform() === 'web'.
• Pas le volume: mute reflète le mode silencieux ou le bouton physique, pas les curseurs de volume média.
• Modes Android: les modes vibreur ou silencieux comptent toujours comme étant en mode mute pour les alertes.

Aperçu de API

isMuted

Vérifiez si le mode silencieux de l'appareil est activé.

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

Référence de type

MuteResponse

Réponse de la vérification du statut de mute.

export interface MuteResponse {
  /** True if device is muted, false otherwise */
  value: boolean;
}

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utilisation de @capgo/capacitor-mute pour la capacité native dans l'utilisation de @capgo/capacitor-mute, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.