Premiers pas

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 avec les commandes suivantes, puis suivez les instructions spécifiques à chaque plateforme ci-dessous :

npm install @capgo/capacitor-audio-session
npx cap sync

Importer

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

Démarrage rapide

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

await AudioSession.overrideOutput('speaker');

Erreurs courantes

• Focus iOS: les API de routage ciblent le comportement de la session audio iOS.
• Restaurer: appeler overrideOutput('default') une fois les appels terminés.
• Ordering: à configurer avant le démarrage de Twilio ou des plugins média.

Aperçu de API

currentOutputs

Récupérez les routes de sortie audio actives.

Sur le web et les plateformes autres qu'iOS, cela renvoie un tableau vide.

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

const result = await AudioSession.currentOutputs();
console.log(result);

overrideOutput

Remplacez la route de sortie audio actuelle.

Utilisez speaker pour forcer la lecture via le haut-parleur intégré, ou default pour rétablir la sortie sélectionnée par le système.

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

const result = await AudioSession.overrideOutput('default');
console.log(result);

Référence de type

AudioSessionPorts

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 override de sortie. - default: Utiliser la route sélectionnée par le système. - speaker: Force la lecture via 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é 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',
}

Source de vérité

Cette page est générée à partir du src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Premiers pas pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-audio-session pour la fonctionnalité native dans « Utiliser @capgo/capacitor-audio-session », Utiliser @capgo/capacitor-live-activities pour la fonctionnalité native de la page Utiliser @capgo/capacitor-live-activities, @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities , Utiliser @capgo/capacitor-video-player pour la capacité native dans Utiliser @capgo/capacitor-video-player , et @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player.