Inicio rápido

Copiar una solicitud 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-audio-session`, `@capgo/capacitor-audiosession`
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/audiosession/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-audio-session` plugin in my project.

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-audio-session
bunx cap sync

Importar

import { AudioSession } from '@capgo/capacitor-audio-session';

API Resumen

`currentOutputs`

Obtenga las rutas de salida de audio activas actuales.

En plataformas web y no-iOS, esto se resuelve en un array vacío.

import { AudioSession } from '@capgo/capacitor-audio-session';

await AudioSession.currentOutputs();

`overrideOutput`

Sobreescribir la ruta de salida de audio actual.

Usar speaker para forzar la reproducción a través del altavoz incorporado, o default para restaurar la ruta seleccionada por el sistema.

import { AudioSession } from '@capgo/capacitor-audio-session';

await AudioSession.overrideOutput({} as OutputOverrideType);

Referencia de tipos

`AudioSessionPorts`

Rutas de salida de audio disponibles en iOS.

export enum AudioSessionPorts {
  AIR_PLAY = 'airplay',
  BLUETOOTH_LE = 'bluetooth-le',
  BLUETOOTH_HFP = 'bluetooth-hfp',
  BLUETOOTH_A2DP = 'bluetooth-a2dp',
  BUILT_IN_SPEAKER = 'builtin-speaker',
  BUILT_IN_RECEIVER = 'builtin-receiver',
  HDMI = 'hdmi',
  HEADPHONES = 'headphones',
  LINE_OUT = 'line-out',
}

`OutputOverrideType`

Tipo de sobrescritura de salida. - default: Utilice la ruta seleccionada por el sistema. - speaker: Forzar la reproducción a través del altavoz incorporado.

export type OutputOverrideType = 'default' | 'speaker';

`OverrideResult`

Resultado de una solicitud de sobrescritura de salida.

export type OverrideResult = {
  success: boolean;
  message: string;
};

`RouteChangeListener`

Escuchador llamado cuando cambia la ruta de audio.

export type RouteChangeListener = (reason: RouteChangeReasons) => void;

`InterruptionListener`

Se llama cuando la sesión de audio se interrumpe o termina.

export type InterruptionListener = (type: InterruptionTypes) => void;

`RouteChangeReasons`

export enum RouteChangeReasons {
  NEW_DEVICE_AVAILABLE = 'new-device-available',
  OLD_DEVICE_UNAVAILABLE = 'old-device-unavailable',
  CATEGORY_CHANGE = 'category-change',
  OVERRIDE = 'override',
  WAKE_FROM_SLEEP = 'wake-from-sleep',
  NO_SUITABLE_ROUTE_FOR_CATEGORY = 'no-suitable-route-for-category',
  ROUTE_CONFIGURATION_CHANGE = 'route-config-change',
  UNKNOWN = 'unknown',
}

`InterruptionTypes`

export enum InterruptionTypes {
  BEGAN = 'began',
  ENDED = 'ended',
}

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts . Re-ejecutar 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 el comportamiento de medios y interfaces nativos, conecta con Usando @capgo/capacitor-sesión-de-audio para la capacidad nativa en Usando @capgo/capacitor-sesión-de-audio, Usando @capgo/capacitor-actividades-en-vivo para la capacidad nativa en Usando @capgo/capacitor-actividades-en-vivo, @capgo/capacitor-actividades-en-vivo para el detalle de implementación en @capgo/capacitor-actividades-en-vivo, Usando @capgo/capacitor-reproductor-de-vídeo para la capacidad nativa en Usando @capgo/capacitor-reproductor-de-vídeo, y @capgo/capacitor-reproductor-de-videos para los detalles de implementación en @capgo/capacitor-reproductor-de-videos.