Getting Started

Copiez un prompt de configuration avec les étapes d'installation et le guide markdown complet 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.

Installation

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

Importer

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

API Vue d'ensemble

`setMetadata`

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

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

await MediaSession.setMetadata({} as MetadataOptions);

`setPlaybackState`

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

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

await MediaSession.setPlaybackState({} as PlaybackStateOptions);

`setActionHandler`

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

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

await MediaSession.setActionHandler({} as ActionHandlerOptions, {} as ActionHandler | null);

`setPositionState`

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

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

await MediaSession.setPositionState({} as PositionStateOptions);

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.ts. Re-run la synchronisation lorsque le public API change en amont.

Continuer depuis Getting Started

Si vous utilisez Getting Started planer le tableau de bord et les opérations API, connectez-le à En utilisant @capgo/capacitor-media-session pour la capacité native dans En utilisant @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 le détail d'implémentation dans Appareils.