Einstieg

Einen Setup-Befehl mit den Installations-Schritten und der vollständigen Markdown-Guideline für diesen Plugin kopieren.

        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.

Installieren

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

Importieren

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

API Übersicht

`currentOutputs`

Ermitteln Sie die aktuellen aktiven Audioausgabewegungen.

Auf Web- und Nicht-iOS-Plattformen wird dies auf eine leere Liste reduziert.

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

await AudioSession.currentOutputs();

`overrideOutput`

Überschreiben Sie die aktuelle Audioausgabestrecke.

Verwenden Sie speaker um die Wiedergabe über den eingebauten Lautsprecher durchzuführen, oder default um die vom Betriebssystem ausgewählte Strecke wiederherzustellen.

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

await AudioSession.overrideOutput({} as OutputOverrideType);

Typenverweis

`AudioSessionPorts`

Verfügbare Audioausgabestrecken auf 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`

Ausgabestreckenüberschreibenstyp. default: Verwende die vom System ausgewählte Route. - speaker: Zwinge das Abspielen über den eingebauten Lautsprecher.

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

`OverrideResult`

Ergebnis einer Ausgabeverzerrungsanforderung.

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

`RouteChangeListener`

Hörer, der aufgerufen wird, wenn sich die Audio-Route ändert.

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

`InterruptionListener`

Hörer, der aufgerufen wird, wenn die Audio-Sitzung unterbrochen oder beendet wird.

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

Quelle der Wahrheit

Diese Seite wurde von dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.