Getting Started

Copie un prompt de configuración con los pasos de instalación y la guía de markdown completa para este 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.

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el complemento. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación.

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

Importar

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

API Resumen

`setMetadata`

Establece los metadatos del medio de reproducción actual.

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

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

`setPlaybackState`

Actualiza el estado de reproducción de la sesión de medios.

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

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

`setActionHandler`

Registra un manejador para una acción de sesión de medios.

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

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

`setPositionState`

Actualiza el estado de posición para la sesión de medios activa.

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

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

Referencia de tipo

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambia en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola y las operaciones de API, conecta con Usando @capgo/capacitor-media-session para la capacidad nativa en Usando @capgo/capacitor-media-session, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para los detalles de implementación en dispositivos.