Getting Started

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-media-session`
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/media-session/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.

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant 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-media-session` 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 :

bun add @capgo/capacitor-media-session
bunx cap sync

Importer

import { MediaSession } from '@capgo/capacitor-media-session';

API Vue d'ensemble

`setMetadata`

Définit les métadonnées de la média en cours de lecture.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setMetadata({ album: 'album' });

`setPlaybackState`

Met à jour l'état de lecture de la session multimédia.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setPlaybackState({ playbackState: 'none' });

`setActionHandler`

Enregistre un gestionnaire pour une action de session multimédia.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setActionHandler({ action: 'play' }, (details) => {
  console.log(details);
});

`setPositionState`

Mise à jour de l'état de position pour la session multimédia active.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setPositionState({
  duration: 1000,
  playbackRate: 1,
  position: 10,
});

Référence de type

`MetadataOptions`

export interface MetadataOptions {
  album?: string;
  artist?: string;
  artwork?: MediaImage[];
  title?: string;
}

`PlaybackStateOptions`

export interface PlaybackStateOptions {
  playbackState: MediaSessionPlaybackState;
}

`ActionHandlerOptions`

export interface ActionHandlerOptions {
  action: MediaSessionAction;
}

`ActionHandler`

export type ActionHandler = (details: ActionDetails) => void;

`PositionStateOptions`

export interface PositionStateOptions {
  duration?: number;
  playbackRate?: number;
  position?: number;
}

`MediaImage`

export interface MediaImage {
  src: string;
  sizes?: string;
  type?: string;
}

`MediaSessionPlaybackState`

export type MediaSessionPlaybackState = 'none' | 'paused' | 'playing';

`MediaSessionAction`

export type MediaSessionAction =
  | 'play'
  | 'pause'
  | 'seekbackward'
  | 'seekforward'
  | 'previoustrack'
  | 'nexttrack'
  | 'seekto'
  | 'stop';

Source De Vérité

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

Continuez de la section « Getting Started »

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-l’avec En utilisant @capgo/capacitor-media-session pour la capacité native dans L'utilisation de @capgo/capacitor-media-session, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour le détail d'implémentation dans API Clés, et Appareils pour les détails d'implémentation sur les appareils.