Getting Started

Install

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

Import

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

API Overview

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

Type Reference

VolumeButtonListener

Listener function for volume button events.

export type VolumeButtonListener = (event: VolumeButtonPressed) => void;

VolumeButtonPressed

Event data for volume button press.

export interface VolumeButtonPressed {
  /** Direction of the button press */
  direction: VolumeButtonDirection;
}

VolumeButtonDirection

Direction of volume button press.

export type VolumeButtonDirection = 'up' | 'down';

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.