Einstieg

Kopieren Sie einen Einrichtungsprompt mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen 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.

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 Audioausgabewege.

Auf Web- und Nicht-iOS-Plattformen wird dies auf einen leeren Array festgelegt.

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

await AudioSession.currentOutputs();

`overrideOutput`

Überschreiben Sie den aktuellen Audioausgabeweg.

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

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

await AudioSession.overrideOutput({} as OutputOverrideType);

Typenverweis

`AudioSessionPorts`

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

Ausgabebereichsüberschreibungsart. - default: Verwenden Sie die vom System ausgewählte Route. - speaker: Zwingen Sie die Wiedergabe über den eingebauten Lautsprecher.

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

`OverrideResult`

Resultat einer Ausgabebereichsüberschreibungsanfrage.

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

`RouteChangeListener`

Hörer wird aufgerufen, wenn sich die Audio-Routen ändern.

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

`InterruptionListener`

Hörer wird aufgerufen, 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 aus dem Plugin generiert. src/definitions.ts. Wiederholen Sie die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weitergehen von Getting Started

Wenn Sie native Medien und Schnittstellenverhalten planen, verbinden Sie es mit Getting Started für die native Fähigkeit in Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-audio-session Using @capgo/capacitor-audio-session für die native Fähigkeit in Using @capgo/capacitor-live-activities Using @capgo/capacitor-live-activities @capgo/capacitor-live-activities @capgo/capacitor-live-activities für die Implementierungsdetails in @capgo/capacitor-live-aktivitäten Mit @capgo/capacitor-video-player für die native Fähigkeit in Mit @capgo/capacitor-video-player, und @capgo/capacitor-video-player für die Implementierungsdetails in @capgo/capacitor-video-player.