Getting Started

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

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la prompt suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-audio-session` plugin in my project.

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API : Présentation

`currentOutputs`

Obtenez les routes de sortie audio actives actuelles.

On 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 sortie audio actuelle.

Utiliser 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 en charge 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 demande de prise en charge 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é lorsque la session audio est interrompue ou se termine.

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',
}

Section intitulée “Source De Vérité”

Re-générez la synchronisation lorsque la publication __CAPGO_KEEP_0__ change en amont. src/definitions.ts. Re-run the sync when the public API changes upstream.

Source Of Truth

Si vous utilisez l'interface d'accueil pour planifier le comportement des médias et de l'interface native, connectez-l’à Utilisez @capgo/capacitor-session-son pour la capacité native dans Utilisez @capgo/capacitor-session-son, Utilisez @capgo/capacitor-activités-en-vive pour la capacité native dans Utilisez @capgo/capacitor-activités-en-vive, Utilisez @capgo/capacitor-activités-en-vive pour le détail d'implémentation dans @capgo/capacitor-activités-en-vive, Utilisez @capgo/capacitor-joueur-de-videos pour la capacité native dans Utilisez @capgo/capacitor-joueur-de-videos, et @capgo/capacitor-joueur-de-videos @capgo/capacitor-activités-en-vive @capgo/capacitor-session-son @capgo/capacitor-joueur-de-videos @capgo/capacitor-lecteur-visionneuse pour les détails d'implémentation dans @capgo/capacitor-lecteur-visionneuse.