Einstieg

Eine Einrichtungsvorlage mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-volume-buttons`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/volume-buttons/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren

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

Importieren

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

API Übersicht

`addListener`

Hört auf Knopfdruckereignisse auf den Hardware-Lautstärkeregulatorknöpfen ab.

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`

Entfernt alle Listener für dieses Plugin.

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

await VolumeButtons.removeAllListeners();

`getPluginVersion`

Ermittelt die native Capacitor-Pluginversion.

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

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

Typenverweis

`VolumeButtonListener`

Funktion zum Abhören von Ereignissen für den Lautstärkewechselknopf.

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

`VolumeButtonPressed`

Ereignisdaten für den Lautstärkewechselknopfdruck.

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

`VolumeButtonDirection`

Richtung des Lautstärkewechselknopfdrucks.

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

Quelle der Wahrheit

Diese Seite wird von der Plugin-Quelle generiert. src/definitions.ts. Wiederholen Sie die Synchronisierung, wenn die öffentliche API upstream geändert wird.