Démarrage

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce 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.

Installer

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

Importer

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

API Aperçu

`currentOutputs`

Obtenir les routes de sortie audio actives actuelles.

Sur les plateformes web et non iOS, cela se résout en un tableau vide.

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

await AudioSession.currentOutputs();

`overrideOutput`

Surmonter la route de sortie audio actuelle.

Utilisez speaker pour forcer la lecture à travers le haut-parleur intégré, ou default pour restaurer la route sélectionnée par le système.

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

await AudioSession.overrideOutput({} as OutputOverrideType);

Référence de type

`AudioSessionPorts`

Les routes de sortie audio disponibles sur 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`

Type de prise de contrôle de sortie. - default: Utiliser la route sélectionnée par le système. - speaker: Forcer la lecture à travers le haut-parleur intégré.

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

`OverrideResult`

Résultat d'une requête de remplacement de sortie.

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

`RouteChangeListener`

Écouteur appelé lors d'un changement de route audio.

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

`InterruptionListener`

Écouteur appelé lors d'une interruption ou de la fin de la session 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',
}

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-faire la synchronisation lorsque le public API change en amont.

Continuez de l'étape « Getting Started »

Si vous utilisez Getting Started pour planifier le comportement natif des médias et de l'interface, connectez-le avec Utilisez @capgo/capacitor-audio-session pour la capacité native dans Utilisez @capgo/capacitor-audio-session, Utiliser @capgo/capacitor-activités-en-vive pour la capacité native dans Utiliser @capgo/capacitor-activités-en-vive, @capgo/capacitor-activités-en-vive pour le détail d'implémentation dans @capgo/capacitor-activités-en-vive, Utiliser @capgo/capacitor-joueur-de-videos pour la capacité native dans Utiliser @capgo/capacitor-joueur-de-videos, et @capgo/capacitor-joueur-de-videos pour le détail d'implémentation dans @capgo/capacitor-joueur-de-videos.