Inicio

Instalar

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

Importar

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

API Resumen

setMetadata

Establece la metadata del medio de reproducción actual.

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

await MediaSession.setMetadata({} as MetadataOptions);

setPlaybackState

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

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

await MediaSession.setPlaybackState({} as PlaybackStateOptions);

setActionHandler

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

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

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

setPositionState

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

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

await MediaSession.setPositionState({} as PositionStateOptions);

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 desde el plugin’s src/definitions.ts. Re-ejecutar la sincronización cuando el público API cambia en la fuente.

Continuar desde Inicio rápido

Si estás utilizando Inicio rápido para planificar la consola de dashboard y API operaciones, conectarlo 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 el detalle de implementación en Dispositivos.