Getting Started

Copie un prompt de configuración con los pasos de instalación y la guía de markdown completa para este 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.

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice la siguiente solicitud:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-volume-buttons` plugin in my project.

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación.

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

Importar

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

Resumen de API

`addListener`

Escuchar presiones en los botones de volumen del hardware.

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`

Elimina todos los oyentes para este plugin.

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

await VolumeButtons.removeAllListeners();

`getPluginVersion`

Obtenga la versión nativa del plugin Capacitor.

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

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

Referencia de tipo

`VolumeButtonListener`

Función de escucha para eventos de botón de volumen.

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

`VolumeButtonPressed`

Datos de evento para presionar botón de volumen.

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

`VolumeButtonDirection`

Dirección del botón de volumen presionado.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecuta la sincronización cuando el público API cambia en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard y API operaciones, conecte con Usando @capgo/capacitor-botones-de-volumen para la capacidad nativa en Usando @capgo/capacitor-botones-de-volumen, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos Para los detalles de implementación en dispositivos.