Guida rapida

Installazione

Puoi usare il nostro Setup assistito dall'AI per installare il plugin. Aggiungi le skill Capgo al tuo tool AI con il comando seguente:

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

Poi usa questo prompt:

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

Se preferisci il Setup manuale, installa il plugin eseguendo i comandi seguenti e segui le istruzioni specifiche per piattaforma qui sotto:

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

Importa

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

Avvio rapido

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

await AudioSession.overrideOutput('speaker');

Errori comuni

• Focus su iOS: le API di routing mirano al comportamento della sessione audio su iOS.
• Ripristina: chiama overrideOutput('default') alla fine delle chiamate.
• Ordinamento: configura prima l'avvio di Twilio o dei plugin media.

API Panoramica

currentOutputs

Ottieni le rotte di output audio attualmente attive.

Su web e piattaforme non iOS, restituisce un array vuoto.

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

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

overrideOutput

Sovrascrivi l'attuale percorso di uscita audio.

Usa speaker per forzare la riproduzione tramite l'altoparlante integrato, o default per ripristinare la rotta selezionata dal sistema.

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

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

Riferimento ai tipi

AudioSessionPorts

Rotte di uscita audio disponibili su 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

Tipo di override dell'output. - default: Usa la rotta selezionata dal sistema. - speaker: Forza la riproduzione tramite l'altoparlante integrato.

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

OverrideResult

Risultato di una richiesta di override dell'output.

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

RouteChangeListener

Listener chiamata quando la rotta audio cambia.

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

InterruptionListener

Listener chiamata quando la sessione audio viene interrotta o termina.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Guida rapida per pianificare il comportamento dei media nativi e dell'interfaccia, collegalo a Utilizzo di @capgo/capacitor-audio-session per la funzionalità nativa in Utilizzo di @capgo/capacitor-audio-session, Usare @capgo/capacitor-live-activities per la funzionalità nativa nella guida Usare @capgo/capacitor-live-activities, @capgo/capacitor-live-activities per i dettagli di implementazione in @capgo/capacitor-live-activities, Usare @capgo/capacitor-video-player per la funzionalità nativa in Utilizzo di @capgo/capacitor-video-player, e @capgo/capacitor-video-player per il dettaglio di implementazione in @capgo/capacitor-video-player.