Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant 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 au plateforme ci-dessous :

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 en charge de sortie. defaultUtiliser la route sélectionnée par le système. speakerForcer la lecture à travers le haut-parleur intégré.

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

OverrideResult

Résultat d'une requête de surcharge 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.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le comportement de médias et d'interface natifs, connectez-le avec Utiliser @capgo/capacitor-audio-session pour la capacité native dans Utiliser @capgo/capacitor-audio-session, En utilisant @capgo/capacitor-activités-en-vive pour la capacité native dans En utilisant @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 En utilisant @capgo/capacitor-joueur-de-videos pour la capacité native dans En utilisant @capgo/capacitor-joueur-de-videos, et @capgo/capacitor-joueur-de-videos pour le détail d'implémentation dans @capgo/capacitor-joueur-de-videos