# @capgo/capacitor-media-session 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-media-session/

版本：8\.1\.8
npm 元数据更新时间：2026-11-09T07:22:35.760Z
中文译文更新时间：2026-11-09T02:48:07.219Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-media-session
原文对照：https://npmcn.com/package/%40capgo/capacitor-media-session/?lang=original
项目主页：https://capgo.app/docs/plugins/media-session/
源码仓库：https://github.com/Cap-go/capacitor-media-session

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：102 kB，35 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-10-09T16:37:37.547Z
- 最新版本发布：2026-11-09T07:22:35.448Z
- 近 30 天下载量：76657（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 47 个）

## 中文简介

显示设备的媒体会话控制器插件

## 安装

```sh
npm install @capgo/capacitor-media-session
```

也可以使用：`pnpm add @capgo/capacitor-media-session`、`yarn add @capgo/capacitor-media-session`、`bun add @capgo/capacitor-media-session`

## README

# @capgo/capor-media-会话

在锁定屏幕上显示当前播放的信息和媒体控制,在您的 Capacitor app 中显示音频或视频的通知阴影和控制中心.

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-media-session)](https://capgo.app/?ref=plugin_media_session)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_media_session)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_media_session) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-media-session` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _添加@capgo/capor-media-session 到我的Capacitor app,并把它连接起来。"_ [代理设置指南](https://capgo.app/agents/?ref=plugin_media_session) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_media_session)

![@capgo/capacitor-media-session for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-media-session/main/assets/github-social-preview.png)

## 主要特点

-   **元数据**数字 : `setMetadata()` 设定标题,艺术家,相册和艺术品.
-   **回放状态**数字 : `setPlaybackState()` 显示播放、暂停或没有.
-   **远程控制**数字 : `setActionHandler()` 处理播放、暂停、查找、下个和上一个.
-   **进展**数字 : `setPositionState()` 更新持续时间、位置和回放率.
-   **平台**:iOS,Android和Web. iOS使用MediaPlayer现在播放信息,Android使用媒体会话服务. Web 使用媒体会话 API.

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/media-session/ (中文(简体) )](https://capgo.app/docs/plugins/media-session/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

> **说明:** 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

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

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capgo/capacitor-media-session
npx cap sync
```

## API 密码

-   [`setMetadata(...)`](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-setmetadata)
-   [`setPlaybackState(...)`](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-setplaybackstate)
-   [`setActionHandler(...)`](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-setactionhandler)
-   [`setPositionState(...)`](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-setpositionstate)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-type-aliases)

### 设置元数据(...)

```typescript
setMetadata(options: MetadataOptions) => Promise<void>
```

设置当前播放媒体的元数据 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[MetadataOptions](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-metadataoptions)` |

* * *

### 设置Playback State(...)

```typescript
setPlaybackState(options: PlaybackStateOptions) => Promise<void>
```

更新媒体会话的播放状态.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PlaybackStateOptions](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-playbackstateoptions)` |

* * *

### 设置 ActionHandler (...)

```typescript
setActionHandler(options: ActionHandlerOptions, handler: ActionHandler | null) => Promise<void>
```

注册媒体会话动作的处理器.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ActionHandlerOptions](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-actionhandleroptions)` |
| **`handler`** | `[ActionHandler](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-actionhandler) | null` |

* * *

### 设置状态(...)

```typescript
setPositionState(options: PositionStateOptions) => Promise<void>
```

更新活动媒体会话的位置状态 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PositionStateOptions](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-positionstateoptions)` |

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

获取本地 Capacitor 插件版本

**回返情况:** `Promise<{ version: string; }>`

* * *

### 接口

#### 元数据选项

| Prop | 类型 |
| --- | --- |
| **`album`** | `string` |
| **`artist`** | `string` |
| **`artwork`** | `MediaImage[]` |
| **`title`** | `string` |

#### 介质图像

| Prop | 类型 |
| --- | --- |
| **`src`** | `string` |
| **`sizes`** | `string` |
| **`type`** | `string` |

#### 播放状态选项

| Prop | 类型 |
| --- | --- |
| **`playbackState`** | `[MediaSessionPlaybackState](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-mediasessionplaybackstate)` |

#### 动作汉德勒选项

| Prop | 类型 |
| --- | --- |
| **`action`** | `[MediaSessionAction](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-mediasessionaction)` |

#### 动作详情

| Prop | 类型 |
| --- | --- |
| **`action`** | `[MediaSessionAction](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-mediasessionaction)` |
| **`seekTime`** | `number | null` |

#### 位置状态选项

| Prop | 类型 |
| --- | --- |
| **`duration`** | `number` |
| **`playbackRate`** | `number` |
| **`position`** | `number` |

### 类型异名

#### 媒体会议播放状态

`'none' | 'paused' | 'playing'`

#### 媒体会议行动

`'play' | 'pause' | 'seekbackward' | 'seekforward' | 'previoustrack' | 'nexttrack' | 'seekto' | 'stop'`

#### 动作汉德勒

`(details: [ActionDetails](https://npmcn.com/package/%40capgo/capacitor-media-session/#readme-actiondetails)): void`

## 常见问题

### @capgo/capacitor-media-session 是什么？

显示设备的媒体会话控制器插件

### 如何安装 @capgo/capacitor-media-session？

在项目目录运行 npm install @capgo/capacitor-media-session，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-media-session 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-media-session 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-media-session 可以商用吗？

@capgo/capacitor-media-session 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-media-session 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-media-session 在 2026/10/09 – 2026/11/07 这 30 天内被下载 76,657 次，日均约 2,555 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-media-session 还在维护吗？

最新版本 8\.1\.8 发布于 2026/11/09（今天）；至今共发布 58 个版本，其中过去 12 个月发布了 47 个；首次发布于 2025/10/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。