スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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

次に、以下のプロンプトを使用します：

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

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-mute
bunx cap sync

インポート

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

クイックスタート

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

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

例：ゲーム内のゲート音

ハードウェアスイッチはアプリのイベントを伴わずに切り替わる可能性があるため、レベル開始時やユーザーがコントロールセンターから戻った際にミュート状態をポーリングしてください。

よくある落とし穴

• Webは非対応: Capacitor のWebビルドを保護します Capacitor.getPlatform() === 'web'.
• 音量ではありません: muteは着信音やハードウェアの消音状態を反映し、メディア音量スライダーとは異なります。
• Androidのモード: マナーモード（バイブレーションのみ、またはサイレント）は、通知音に関しては消音状態とみなされます。

API の概要

isMuted

デバイスのミュートスイッチがオンになっているか確認します。

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

型リファレンス

MuteResponse

ミュート状態確認時のレスポンス。

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

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-mute を使用 @capgo/capacitor-mute を使用してネイティブ機能を利用する場合: API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。