メインコンテンツへスキップ
@capgo/capacitor-volume-buttons デバイス API オープンソース

音量ボタン Capacitor プラグイン

ハードウェアの音量ボタンの入力を検知し、アプリ独自の操作やショートカットを実現します

インストール

bun add @capgo/capacitor-volume-buttons bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-volume-buttons
  • pnpm add @capgo/capacitor-volume-buttons
  • yarn add @capgo/capacitor-volume-buttons

ガイド

Capacitor で Volume Buttons を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Volume Buttons プラグインのプレビューQR code

@capgo/capacitor-volume-buttons の使用方法

ハードウェアの音量ボタンの押下を検知する Capacitor Volume Buttons Plugin

インストール

bun add @capgo/capacitor-volume-buttons
bunx cap sync

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

API の概要

メソッド 説明
addListener ハードウェアの音量ボタンの押下を検知します。
removeAllListeners このプラグインのすべてのリスナーを削除します。
getPluginVersion ネイティブの Capacitor プラグインのバージョンを取得します。

例

addListener()

ハードウェアの音量ボタンの押下を検知します。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

const listener = await VolumeButtons.addListener(
  'volumeButtonPressed',
  (event) => {
    console.log(`Volume ${event.direction} button pressed`);
  }
);

// Remove listener when done
await listener.remove();

removeAllListeners()

このプラグインのすべてのリスナーを削除します。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

await VolumeButtons.removeAllListeners();

getPluginVersion()

ネイティブの Capacitor プラグインのバージョンを取得します。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

const { version } = await VolumeButtons.getPluginVersion();
console.log('Plugin version:', version);

イベントをリッスンする

addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または VolumeButtons.removeAllListeners() すべてのリスナーを解除します。

完全なリファレンス

@capgo/capacitor-volume-buttons の使用方法から

使用している場合 @capgo/capacitor-volume-buttons の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-volume-buttons @capgo/capacitor-volume-buttons の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

Volume Buttons プラグイン FAQ

Capacitor アプリに Volume Buttons プラグインをインストールするにはどうすればよいですか?

"bun add @capgo/capacitor-volume-buttons" (または "npm install @capgo/capacitor-volume-buttons") を実行し、次に "bunx cap sync" を実行して、iOS および Android プロジェクトにネイティブの code を反映させます。その後、アプリの code から "@capgo/capacitor-volume-buttons" をインポートしてください。

@capgo/capacitor-volume-buttons は React、Vue、Angular で動作しますか?

はい。Volume Buttons は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用できます。

@capgo/capacitor-volume-buttons はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-volume-buttonsは無料かつオープンソースですか?

はい。codeのソースコードはGitHubの https://github.com/Cap-go/capacitor-volume-buttons/ で公開されており、npmから無料でインストールできます。バグ報告やプルリクエストもお待ちしています。

App Storeの審査なしで、Volume Buttonsを使用しているcodeをアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに、ボリュームボタンの変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める