Inicio

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 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-audio-session
bunx cap sync

Importar

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

API Resumen

currentOutputs

Obtén 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

Override 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 : Reproduzca 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

Escuchador llamado cuando se interrumpe o finaliza la sesión de audio.

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 desde el plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente

Sigue adelante desde Getting Started

Si estás utilizando Empezar para planificar el comportamiento de medios y interfaces nativos, conectarlo con Usando @capgo/capacitor-audio-session para la capacidad nativa en Usando @capgo/capacitor-audio-session, Usando @capgo/capacitor-live-activities para la capacidad nativa en Usando @capgo/capacitor-live-activities, @capgo/capacitor-live-activities para el detalle de implementación en @capgo/capacitor-live-activities, Usando @capgo/capacitor-video-player para la capacidad nativa en Usando @capgo/capacitor-video-player, y @capgo/capacitor-video-player para el detalle de implementación en @capgo/capacitor-video-player.