Iniziato

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo abilità al tuo strumento di AI utilizzando il seguente comando:

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

Usa poi la seguente richiesta:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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

Importa

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

API Panoramica

currentOutputs

Ottieni le attuali rotte di output audio attive.

On web e piattaforme non iOS, questo si risolve in un array vuoto.

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

await AudioSession.currentOutputs();

overrideOutput

Sovrascrivi l'attuale route di output audio.

Usa speaker per forzare la riproduzione attraverso lo speaker integrato, o default per ripristinare la route selezionata dal sistema.

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

await AudioSession.overrideOutput({} as OutputOverrideType);

Riferimento di tipo

AudioSessionPorts

Route di output 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 sovrascrittura dell'output. - default: Utilizza la rotta selezionata dal sistema. - speaker: Forza il riproduzione attraverso lo speaker integrato.

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

OverrideResult

Risultato di una richiesta di sovrascrittura dell'output.

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

RouteChangeListener

Ascoltatore chiamato quando cambia la rotta audio.

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

InterruptionListener

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

Punto di riferimento

Questa pagina è generata dal plugin’s src/definitions.tsRiavvia la sincronizzazione quando il pubblico API cambia in modo upstream.

Continua da Iniziare

Se stai utilizzando Inizia per pianificare il comportamento dei media nativi e dell'interfaccia, connettilo con Usando @capgo/capacitor-sessione-audio per la capacità nativa in Usando @capgo/capacitor-sessione-audio, Usando @capgo/capacitor-attività-vive per la capacità nativa in Usando @capgo/capacitor-attività-vive, @capgo/capacitor-attività-vive per il dettaglio di implementazione in @capgo/capacitor-attività-vive, Usando @capgo/capacitor-lettore-video per la capacità nativa in Usando @capgo/capacitor-lettore-video, e @capgo/capacitor-player-video per i dettagli di implementazione in @capgo/capacitor-player-video.