Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-volume-buttons
Tutorial
by github.com/Cap-go

Volume Buttons

Capture hardware volume button presses for custom app controls and shortcuts

Downloads/week

901

GitHub Stars

4

Guide

Tutorial on Volume Buttons

Using @capgo/capacitor-volume-buttons

Capacitor Volume Buttons Plugin for detecting hardware volume button presses.

Install

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

What This Plugin Exposes

  • addListener - Listen for presses on the hardware volume buttons.
  • removeAllListeners - Removes all listeners for this plugin.
  • getPluginVersion - Get the native Capacitor plugin version.

Example Usage

addListener

Listen for presses on the hardware volume buttons.

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

Removes all listeners for this plugin.

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

await VolumeButtons.removeAllListeners();

getPluginVersion

Get the native Capacitor plugin version.

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

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

Full Reference