Einstieg

Installieren

bun add @capgo/native-audio
bunx cap sync

Importieren

import { NativeAudio } from '@capgo/native-audio';

API Übersicht

configure

Die Audio-Player-Konfiguration anpassen

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.configure({} as ConfigureOptions);

preload

Ein Audio-Datei laden

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.preload({} as PreloadOptions);

playOnce

Ein Audio-Datei einmal abspielen und automatisch bereinigen

Methode für einfache, einmalige Audioabspielungen, wie z.B. Benachrichtigungen, UI-Feedback oder andere kurze Audio-Clips, die keine manuelle Zustandsverwaltung erfordern.

Hauptmerkmale:

• Fire-and-forget: Keine manuelle Vorbereitung, Abspielung, Stop oder Entladung erforderlich
• Auto-bereinigung: Der Asset wird automatisch gelöscht, nachdem die Abspielung abgeschlossen ist
• Optionale Dateilöschung: Kann lokale Dateien nach Abspielung löschen (nützlich für temporäre Dateien)
• Gibt assetId zurück: Kann noch die Steuerung des Abspielens durchführen, wenn nötig (Pause, Stop usw.)

Verwendungsfälle:

• Benachrichtigungsgeräusche
• Benutzeroberflächengeräusche (Tastenklische, Warnungen)
• Kurze Audio-Clips, die einmal abgespielt werden
• Temporäre Audio-Dateien, die gelöscht werden sollten

Vergleich mit der regulären Funktion play():

• play(): Benötigt manuelle Vorkomprimierung, Abspielung und Auflösungsschritte
• playOnce(): Führt alles automatisch mit einem einzigen Aufruf durch

import { NativeAudio } from '@capgo/native-audio';

// Simple one-shot playback
await NativeAudio.playOnce({ assetPath: 'audio/notification.mp3' });

// Play and delete the file after completion
await NativeAudio.playOnce({
  assetPath: 'file:///path/to/temp/audio.mp3',
  isUrl: true,
  deleteAfterPlay: true
});

// Get the assetId to control playback
const { assetId } = await NativeAudio.playOnce({
  assetPath: 'audio/long-track.mp3',
  autoPlay: true
});
// Later, you can stop it manually if needed
await NativeAudio.stop({ assetId });

isPreloaded

Überprüfen Sie, ob ein Audio-Datei vorab geladen ist

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.isPreloaded({} as PreloadOptions);

play

Ein Audio-Datei abspielen

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.play({} as AssetPlayOptions);

pause

Ein Audio-Datei pausieren

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.pause({} as AssetPauseOptions);

resume

Ein Audio-Datei fortsetzen

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.resume({} as AssetResumeOptions);

loop

Ein Audio-Datei beenden

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.loop({} as Assets);

stop

Ein Audio-Datei beenden

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.stop({} as AssetStopOptions);

unload

Ein Audio-Datei entladen

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.unload({} as Assets);

setVolume

Die Lautstärke einer Audio-Datei einstellen

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.setVolume({} as AssetVolume);

setRate

Setzen Sie die Geschwindigkeit eines Audio-Dateis

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.setRate({} as AssetRate);

setCurrentTime

Setzen Sie die aktuelle Zeit eines Audio-Dateis

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.setCurrentTime({} as AssetSetTime);

getCurrentTime

Ermitteln Sie die aktuelle Zeit eines Audio-Dateis

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.getCurrentTime({} as Assets);

getDuration

Ermitteln Sie die Dauer eines Audio-Dateis in Sekunden

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.getDuration({} as Assets);

isPlaying

Überprüfen Sie, ob ein Audio-Datei abgespielt wird

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.isPlaying({} as Assets);

clearCache

Löschen Sie den Audio-Cache für remote Audio-Dateien

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.clearCache();

setDebugMode

Debug-Modus-Protokollierung einstellen

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.setDebugMode({} as { enabled: boolean });

deinitPlugin

Deinitialisieren Sie das Plugin und setzen Sie die ursprünglichen Audio-Sitzungs-Einstellungen zurück Diese Methode stoppt alle abgespielten Audio-Dateien und kehrt alle Audio-Sitzungs-Änderungen zurück, die durch das Plugin vorgenommen wurden Verwenden Sie dies, wenn Sie sicherstellen müssen, dass die Kompatibilität mit anderen Audio-Plugins gewährleistet ist

import { NativeAudio } from '@capgo/native-audio';

await NativeAudio.deinitPlugin();

Typenreferenz

ConfigureOptions

export interface ConfigureOptions {
  /**
   * focus the audio with Audio Focus
   */
  focus?: boolean;
  /**
   * Play the audio in the background
   */
  background?: boolean;
  /**
   * Ignore silent mode, works only on iOS setting this will nuke other audio apps
   */
  ignoreSilent?: boolean;
  /**
   * Show audio playback in the notification center (iOS and Android)
   * When enabled, displays audio metadata (title, artist, album, artwork) in the system notification
   * and Control Center (iOS) or lock screen.
   *
   * **Important iOS Behavior:**
   * Enabling this option changes the audio session category to `.playback` with `.default` mode,
   * which means your app's audio will **interrupt** other apps' audio (like background music from
   * Spotify, Apple Music, etc.) instead of mixing with it. This is required for the Now Playing
   * info to appear in Control Center and on the lock screen.
   *
   * **Trade-offs:**
   * - `showNotification: true` → Shows Now Playing controls, but interrupts other audio
   * - `showNotification: false` → Audio mixes with other apps, but no Now Playing controls
   *
   * Use this when your app is the primary audio source (music players, podcast apps, etc.).
   * Disable this for secondary audio like sound effects or notification sounds where mixing
   * with background music is preferred.
   *
   * @see https://github.com/Cap-go/capacitor-native-audio/issues/202
   */
  showNotification?: boolean;
  /**
   * Enable background audio playback (Android only)
   *
   * When enabled, audio will continue playing when the app is backgrounded or the screen is locked.
   * The plugin will skip the automatic pause/resume logic that normally occurs when the app
   * enters the background or returns to the foreground.
   *
   * **Important Android Requirements:**
   * To use background playback on Android, your app must:
   * 1. Declare the required permissions in `AndroidManifest.xml`:
   *    - `<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />`
   *    - `<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />`
   *    - `<uses-permission android:name="android.permission.WAKE_LOCK" />`
   * 2. Start a Foreground Service with a media-style notification before backgrounding
   *    (the plugin does not automatically create or manage the foreground service)
   * 3. Use `showNotification: true` to display playback controls in the notification
   *
   * **Usage Example:**
   * ```typescript
   * await NativeAudio.configure({
   *   backgroundPlayback: true,
   *   showNotification: true
   * });
   * // Start your foreground service here
   * // Then preload and play audio as normal
   * ```
   *
   * @default false
   * @platform Android
   * @since 8.2.0
   */
  backgroundPlayback?: boolean;
}

PreloadOptions

export interface PreloadOptions {
  /**
   * Path to the audio file, relative path of the file, absolute url (file://) or remote url (https://)
   * Supported formats:
   * - MP3, WAV (all platforms)
   * - M3U8/HLS streams (iOS and Android)
   */
  assetPath: string;
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;
  /**
   * Volume of the audio, between 0.1 and 1.0
   */
  volume?: number;
  /**
   * Audio channel number, default is 1
   */
  audioChannelNum?: number;
  /**
   * Is the audio file a URL, pass true if assetPath is a `file://` url
   * or a streaming URL (m3u8)
   */
  isUrl?: boolean;
  /**
   * Metadata to display in the notification center when audio is playing.
   * Only used when `showNotification: true` is set in `configure()`.
   *
   * See {@link ConfigureOptions.showNotification} for important details about
   * how this affects audio mixing behavior on iOS.
   *
   * @see NotificationMetadata
   */
  notificationMetadata?: NotificationMetadata;
  /**
   * Custom HTTP headers to include when fetching remote audio files.
   * Only used when isUrl is true and assetPath is a remote URL (http/https).
   * Example: { 'x-api-key': 'abc123', 'Authorization': 'Bearer token' }
   *
   * @since 7.10.0
   */
  headers?: Record<string, string>;
}

PlayOnceOptions

export interface PlayOnceOptions {
  /**
   * Path to the audio file, relative path of the file, absolute url (file://) or remote url (https://)
   * Supported formats:
   * - MP3, WAV (all platforms)
   * - M3U8/HLS streams (iOS and Android)
   */
  assetPath: string;
  /**
   * Volume of the audio, between 0.1 and 1.0
   * @default 1.0
   */
  volume?: number;
  /**
   * Is the audio file a URL, pass true if assetPath is a `file://` url
   * or a streaming URL (m3u8)
   * @default false
   */
  isUrl?: boolean;
  /**
   * Automatically start playback after loading
   * @default true
   */
  autoPlay?: boolean;
  /**
   * Delete the audio file from disk after playback completes
   * Only works for local files (file:// URLs), ignored for remote URLs
   * @default false
   * @since 7.11.0
   */
  deleteAfterPlay?: boolean;
  /**
   * Metadata to display in the notification center when audio is playing.
   * Only used when `showNotification: true` is set in `configure()`.
   *
   * See {@link ConfigureOptions.showNotification} for important details about
   * how this affects audio mixing behavior on iOS.
   *
   * @see NotificationMetadata
   * @since 7.10.0
   */
  notificationMetadata?: NotificationMetadata;
  /**
   * Custom HTTP headers to include when fetching remote audio files.
   * Only used when isUrl is true and assetPath is a remote URL (http/https).
   * Example: { 'x-api-key': 'abc123', 'Authorization': 'Bearer token' }
   *
   * @since 7.10.0
   */
  headers?: Record<string, string>;
}

PlayOnceResult

export interface PlayOnceResult {
  /**
   * The internally generated asset ID for this playback
   * Can be used to control playback (pause, stop, etc.) before completion
   */
  assetId: string;
}

AssetPlayOptions

export interface AssetPlayOptions {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;
  /**
   * Time to start playing the audio, in seconds
   */
  time?: number;
  /**
   * Delay to start playing the audio, in seconds
   */
  delay?: number;

  /**
   * Volume of the audio, between 0.1 and 1.0
   */
  volume?: number;

  /**
   * Whether to fade in the audio
   */
  fadeIn?: boolean;

  /**
   * Whether to fade out the audio
   */
  fadeOut?: boolean;

  /**
   * Fade in duration in seconds.
   * Only used if fadeIn is true.
   * Default is 1s.
   */
  fadeInDuration?: number;

  /**
   * Fade out duration in seconds.
   * Only used if fadeOut is true.
   * Default is 1s.
   */
  fadeOutDuration?: number;

  /**
   * Time in seconds from the start of the audio to start fading out.
   * Only used if fadeOut is true.
   * Default is fadeOutDuration before end of audio.
   */
  fadeOutStartTime?: number;
}

AssetPauseOptions

export interface AssetPauseOptions {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;

  /**
   * Whether to fade out the audio before pausing
   */
  fadeOut?: boolean;

  /**
   * Fade out duration in seconds.
   * Default is 1s.
   */
  fadeOutDuration?: number;
}

AssetResumeOptions

export interface AssetResumeOptions {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;

  /**
   * Whether to fade in the audio during resume
   */
  fadeIn?: boolean;

  /**
   * Fade in duration in seconds.
   * Default is 1s.
   */
  fadeInDuration?: number;
}

Assets

export interface Assets {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;
}

AssetStopOptions

export interface AssetStopOptions {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;

  /**
   * Whether to fade out the audio before stopping
   */
  fadeOut?: boolean;

  /**
   * Fade out duration in seconds.
   * Default is 1s.
   */
  fadeOutDuration?: number;
}

AssetVolume

export interface AssetVolume {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;
  /**
   * Volume of the audio, between 0.1 and 1.0
   */
  volume: number;
  /**
   * Time over which to fade to the target volume, in seconds. Default is 0s (immediate).
   */
  duration?: number;
}

AssetRate

export interface AssetRate {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;
  /**
   * Rate of the audio, between 0.1 and 1.0
   */
  rate: number;
}

AssetSetTime

export interface AssetSetTime {
  /**
   * Asset Id, unique identifier of the file
   */
  assetId: string;
  /**
   * Time to set the audio, in seconds
   */
  time: number;
}

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API changes upstream.