Getting Started

GitHub

Einen Setup-Befehl mit den Installationsanweisungen und der vollständigen Markdown-Anleitung 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

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit folgendem Befehl hinzu:

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

Verwenden Sie dann die folgende Anweisung:

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

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunter angegebenen Plattform-spezifischen Anweisungen befolgen:

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.

On web- und Nicht-iOS-Plattformen wird dies auf eine leere Array auflösen.

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);

Typenreferenz

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

Ausgabestellvertreterart. - default: Verwenden Sie die vom Betriebssystem ausgewählte Route. - speaker: Zwingen Sie die Wiedergabe über den eingebauten Lautsprecher durch.

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

`OverrideResult`

Ergebnis einer Ausgabestellvertreteranforderung.

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

`RouteChangeListener`

Hörer, der bei einem Wechsel der Audio-Route aufgerufen wird.

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

`InterruptionListener`

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 generiert aus dem Plugin’s src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weiter von Getting Started

Wenn Sie native Medien und Schnittstellenverhalten planen, verbinden Sie es mit Getting Started um native Medien und Schnittstellenverhalten zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-Audio-Session um die native Fähigkeit in Verwenden Sie @capgo/capacitor-Audio-Session zu nutzen Verwenden Sie @capgo/capacitor-Live-Aktivitäten um die native Fähigkeit in Verwenden Sie @capgo/capacitor-Live-Aktivitäten zu nutzen @capgo/capacitor-Live-Aktivitäten um die Implementierungsdetails in @capgo/capacitor-Live-Aktivitäten zu nutzen Verwenden Sie @capgo/capacitor-Video-Player um die native Fähigkeit in Verwenden Sie @capgo/capacitor-Video-Player zu nutzen @capgo/capacitor-Video-Player für die Implementierungsdetails in @capgo/capacitor-Video-Player.