Iniziata alla Guida

Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo 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.

Installazione

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

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

Usa poi il seguente prompt:

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 del tuo platform:

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.

Sulla web e su piattaforme non iOS, questo risolve in un array vuoto.

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

await AudioSession.currentOutputs();

`overrideOutput`

Sovrascrivi la corrente rotta di output audio.

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

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

await AudioSession.overrideOutput({} as OutputOverrideType);

Riferimento al tipo

`AudioSessionPorts`

Rotte 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`

Ascoltatore chiamato quando l'audio sessione 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 plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia upstream.

Continua da Inizia con l'installazione

Se stai utilizzando Inizia con l'installazione per pianificare il comportamento dei media e dell'interfaccia nativi, connettilo con Utilizza @capgo/capacitor-audio-session per la capacità nativa in Utilizza @capgo/capacitor-audio-session, Usando @capgo/capacitor-live-attività per la capacità nativa in Usando @capgo/capacitor-live-attività, @capgo/capacitor-live-attività per il dettaglio di implementazione in @capgo/capacitor-live-attività, Usando @capgo/capacitor-player-video per la capacità nativa in Usando @capgo/capacitor-player-video, e @capgo/capacitor-player-video per il dettaglio di implementazione in @capgo/capacitor-player-video.