Getting Started

Eine Einrichtungsanleitung mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen 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.

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunter angegebenen Plattform-spezifischen Anweisungen befolgen:

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

Import

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

API Übersicht

`setMetadata`

Setzt die Metadaten des aktuellen Medieninhalts.

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

await MediaSession.setMetadata({} as MetadataOptions);

`setPlaybackState`

Aktualisiert den Wiedergabezustand der Mediensitzung.

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

await MediaSession.setPlaybackState({} as PlaybackStateOptions);

`setActionHandler`

Registriert einen Handler für eine Mediensitzungsaktion.

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

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

`setPositionState`

Aktualisiert den Positionszustand für die aktive Mediensitzung.

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

await MediaSession.setPositionState({} as PositionStateOptions);

Typenverweis

`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';

Quelle der Wahrheit

Diese Seite wurde von dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie die Synchronisation erneut durch.

Weitermachen von Getting Started

Wenn Sie Getting Started Um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-media-session für die native Fähigkeit in Mit @capgo/capacitor-media-session API-Übersicht für die Implementierungsdetails in API-Übersicht Einführung für die Implementierungsdetails in Einführung API-Schlüssel für die Implementierungsdetails in API-Schlüssel und Geräte für die Implementierungsdetails in Geräte.