Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this 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

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit folgender Befehl hinzu:

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

Dann verwenden Sie die folgende Anfrage:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

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 lautet dies eine leere Array.

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

await AudioSession.currentOutputs();

`overrideOutput`

Überschreibe die aktuelle Audioausgabestrecke.

Verwende speaker zur Zwangswiedergabe über den internen Lautsprecher, oder default to restore the system-selected route.

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`

Ausgabewertüberschreibungstyp. default: Verwende die vom System ausgewählte Route. speaker: Zwangsspielung über den internen Lautsprecher.

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

`OverrideResult`

Erfolg einer Ausgabe-Übernahme-Anforderung.

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

`RouteChangeListener`

Wird aufgerufen, wenn sich die Audio-Routen ändern.

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

`InterruptionListener`

Hörer wird aufgerufen, wenn die Audiositzung 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 wird aus dem Plugin generiert. src/definitions.ts. Re-run the sync when the public API changes upstream.

Weitergehen von Getting Started

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