开始入门

复制一个包含安装步骤和本插件完整 Markdown 指南的配置提示。

        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.

安装

您可以使用我们的 AI 助手来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

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

然后使用以下提示：

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

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明：

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

导入

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

API概述

`setMetadata`

复制到剪贴板

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

await MediaSession.setMetadata({} as MetadataOptions);

`setPlaybackState`

更新媒体会话的播放状态

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

await MediaSession.setPlaybackState({} as PlaybackStateOptions);

`setActionHandler`

注册媒体会话动作的处理程序。

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

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

`setPositionState`

更新当前媒体会话的位置状态。

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

await MediaSession.setPositionState({} as PositionStateOptions);

类型参考

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

真实数据来源

本页面由插件生成 src/definitions.ts当公共 API 上游更改时，请重新运行同步

从 Getting Started 继续

如果您正在使用 Getting Started 来规划仪表板和 API 操作，请将其连接到使用 @capgo/capacitor-media-session 为在 Using @capgo/capacitor-media-session 中使用的本机功能 API 简介查看 API 简介的实现细节介绍查看介绍的实现细节 API 密钥查看 API 密钥的实现细节设备查看设备的实现细节