Getting Started

Eine Anweisung zum Kopieren mit den Installations-Schritten und der vollständigen Markdown-Anleitung für diesen Plugin.

        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`

Auf die Betätigung der Hardware-Tasten für die Lautstärke lauschen.

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 diesen Plugin.

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

await VolumeButtons.removeAllListeners();

`getPluginVersion`

Erhalte die native Capacitor-Pluginversion.

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

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

Typenreferenz

`VolumeButtonListener`

Hörerfunktion für Volume-Tastenereignisse.

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

`VolumeButtonPressed`

Ereignisdaten für Volume-Tastenpressen.

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

`VolumeButtonDirection`

Richtung des Drucks auf den Lautstärkeknopf.

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

Quelle der Wahrheit

Diese Seite wurde von dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API sich im Quellcode ändert.

Weitermachen von Getting Started

Wenn Sie " Getting Started zum Planen von Dashboard und API-Operationen verwenden, verbinden Sie es mit Mit @capgo/capacitor-Lautstärkenknöpfe für die native Fähigkeit in Mit @capgo/capacitor-Lautstärkenknöpfe API Übersicht für die Implementierungsdetails in API Übersicht Einführung für die Implementierungsdetails in Einführung API Schaltflächen für die Implementierungsdetails in API Schaltflächen, und Geräte für die Implementierungsdetails in Geräte.