Getting Started

Instalar

Puedes utilizar nuestra configuración asistida por IA para instalar el plugin. Agrega las Capgo habilidades a tu herramienta de IA utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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 del plataforma a continuación:

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

Importar

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

API Resumen

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 listeners 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 tipos

VolumeButtonListener

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

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

VolumeButtonPressed

Datos de evento para presionar el botón de volumen.

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

VolumeButtonDirection

Dirección del botón de volumen.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ruta 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, conecta 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 el detalle de implementación en Dispositivos.