Getting Started

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

npm install @capgo/capacitor-native-audio
npx cap sync

Importer

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

API Vue d'ensemble

configure

Configurez le lecteur audio

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

await NativeAudio.configure({} as ConfigureOptions);

preload

Charger un fichier audio

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

await NativeAudio.preload({} as PreloadOptions);

playOnce

Lire un fichier audio une fois avec nettoyage automatique

Méthode conçue pour un playback audio simple et ponctuel, suivant des sons de notification, des retours d'informations de l'interface utilisateur ou d'autres courts clips audio qui ne nécessitent pas de gestion de l'état manuelle.

Caractéristiques clés :

• Lâcher-prise: Pas besoin de précharger, de lire, d'arrêter ou de décharger manuellement
• Nettoyage automatique: L'asset est automatiquement déchargé après la fin de la lecture
• Suppression de fichier facultative: Supprime les fichiers locaux après lecture (utile pour les fichiers temporaires)
• Returns assetId: Peut toujours contrôler la lecture si nécessaire (pause, arrêt, etc.)

Utilisations :

• Notifications sonores
• Effets sonores de l'interface utilisateur (cliquages de boutons, alertes)
• Clips audio courts qui se jouent une seule fois
• Fichiers audio temporaires qui doivent être supprimés

Comparaison avec la lecture régulière (play():

• play(): Exige des étapes de chargement manuel, lecture et déchargement
• playOnce(): Gère tout automatiquement avec une seule appelle

import { NativeAudio } from '@capgo/capacitor-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

Vérifiez si un fichier audio est préchargé

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

await NativeAudio.isPreloaded({} as PreloadOptions);

play

Jouez un fichier audio

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

await NativeAudio.play({} as AssetPlayOptions);

pause

Interrompez un fichier audio

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

await NativeAudio.pause({} as AssetPauseOptions);

resume

Résumez un fichier audio

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

await NativeAudio.resume({} as AssetResumeOptions);

loop

Arrêter un fichier audio

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

await NativeAudio.loop({} as Assets);

stop

Arrêter un fichier audio

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

await NativeAudio.stop({} as AssetStopOptions);

unload

Décharger un fichier audio

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

await NativeAudio.unload({} as Assets);

setVolume

Réglage du volume d'un fichier audio

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

await NativeAudio.setVolume({} as AssetVolume);

setRate

Définir le taux d'un fichier audio

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

await NativeAudio.setRate({} as AssetRate);

setCurrentTime

Définir la position actuelle d'un fichier audio

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

await NativeAudio.setCurrentTime({} as AssetSetTime);

getCurrentTime

Obtenir la position actuelle d'un fichier audio

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

await NativeAudio.getCurrentTime({} as Assets);

getDuration

Obtenir la durée d'un fichier audio en secondes

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

await NativeAudio.getDuration({} as Assets);

isPlaying

Vérifiez si un fichier audio est en cours de lecture

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

await NativeAudio.isPlaying({} as Assets);

clearCache

Effacer le cache audio pour les fichiers audio distants

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

await NativeAudio.clearCache();

setDebugMode

Activer le mode débogage pour les journaux

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

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

deinitPlugin

Désinitialiser le plugin et restaurer les paramètres de session audio originaux Cette méthode arrête tous les fichiers audio en cours de lecture et rétablit les modifications apportées à la session audio par le plugin Utilisez cette méthode lorsque vous avez besoin d'assurer la compatibilité avec d'autres plugins audio

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

await NativeAudio.deinitPlugin();

Référence de type

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

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-faire la synchronisation lorsque le public API change en amont.

Continuer depuis Getting Started

Si vous utilisez Getting Started pour planifier le comportement des médias et de l'interface natifs, connectez-le à En utilisant @capgo/capacitor-native-audio pour la capacité native dans En utilisant @capgo/capacitor-native-audio, En utilisant @capgo/capacitor-live-activities pour la capacité native dans En utilisant @capgo/capacitor-live-activities, @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities, En utilisant @capgo/capacitor-video-player pour la capacité native dans En utilisant @capgo/capacitor-video-player, et @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player.