Démarrage

Copiez une commande de configuration avec les étapes d'installation et la guide markdown complet 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 Vue d'ensemble

`currentOutputs`

Obtenir les routes de sortie audio actives actuelles.

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

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

await AudioSession.currentOutputs();

`overrideOutput`

Surcharger la voie de sortie audio actuelle.

Utiliser speaker pour forcer la lecture à travers le haut-parleur intégré, ou default pour restaurer la voie 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`

Voies 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: Utilisez 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 de la demande d'override 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-run la synchronisation lorsque le public API change en amont.