@capgo/capacitor-volume-buttons

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/volume-buttons/

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ---------- | | v8.*.* | v8.*.* | ✅ | | v7.*.* | v7.*.* | On demand | | v6.*.* | v6.*.* | ❌ | | v5.*.* | v5.*.* | ❌ |

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

npm install @capgo/capacitor-volume-buttons
npx cap sync

API

• addListener('volumeButtonPressed', ...)
• removeAllListeners()
• getPluginVersion()
• Interfaces
• Type Aliases

Capacitor Volume Buttons Plugin for detecting hardware volume button presses.

addListener('volumeButtonPressed', ...)

addListener(eventName: 'volumeButtonPressed', listenerFunc: VolumeButtonListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for presses on the hardware volume buttons.

| Param | Type | Description | | ------------------ | --------------------------------------------------------------------- | ------------------------------------------------------ | | eventName | 'volumeButtonPressed' | - The event name (must be 'volumeButtonPressed') | | listenerFunc | VolumeButtonListener | - The function to call when a volume button is pressed |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners for this plugin.

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

VolumeButtonPressed

Event data for volume button press.

| Prop | Type | Description | | --------------- | ----------------------------------------------------------------------- | ----------------------------- | | direction | VolumeButtonDirection | Direction of the button press |

Type Aliases

VolumeButtonListener

Listener function for volume button events.

(event: VolumeButtonPressed): void

VolumeButtonDirection

Direction of volume button press.

'up' | 'down'