# @capgo/capacitor-mux-player 中文文档

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

版本：8\.1\.2
npm 元数据更新时间：2026-10-15T04:51:06.414Z
中文译文更新时间：2026-11-09T04:10:20.021Z
软件包许可：MPL-2\.0

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

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

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

- 包体积（解压后）：147 kB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-09-26T01:54:17.707Z
- 最新版本发布：2026-10-15T04:51:06.098Z
- 近 30 天下载量：39809（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 27 个）

## 中文简介

本地 Mux Player SDK 在 IOS 和 Android 上播放视频

## 安装

```sh
npm install @capgo/capacitor-mux-player
```

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

## README

# @ capgo/ 电容- mux- player

在您的 Capacitor app 中与本地的 Mux Player SDKs 在 iOS 和 Android 上播放 Mux 视频,包括 Mux Data 回放分析.

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

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

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

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

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

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

## 主要特点

-   **全屏回放**数字 : `play()` 打开本地的 Mux 玩家的回放ID .
-   **开除**数字 : `dismiss()` 关闭玩家.
-   **状态**数字 : `isActive()` 报告玩家是否显示.
-   **原生 SDKs**: Mux Player Swift 在iOS上和"Mux Player Android SDK"上,有"Mux Data stats".
-   **平台**: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02. Web提供了基本的倒计时玩家.

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/mux-player/ (英语)](https://capgo.app/docs/plugins/mux-player/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页: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-mux-player` plugin in my project.
```

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

```bash
npm install @capgo/capacitor-mux-player
npx cap sync
```

### iOS 设置

-   需要iOS 15或更新.
-   添加 Swift 软件包 `https://github.com/muxinc/mux-player-swift` 到您的 Xcode 工作区 `MuxPlayerSwift` 模块在构建时可用.
-   如果您通过 CocoaPods 管理本地依赖, 则选择通过 Swift 套件管理器整合此插件, 或将 Mux 套件手动添加到您的应用目标中 .

### 机器人设置

-   Gradle 将玩家从 Mux 文物中拉出(`https://muxinc.jfrog.io/artifactory/default-maven-release-local`) (中文(简体) ). 确保您的公司代理允许从该主机下载 .
-   `npx cap sync android` 添加 Mux 马文寄存器到 `android/build.gradle` 自动。 如果在您的工程中 Capacitor 生命周期钩被禁用, 请将寄存器手动添加到根 Gradle 配置中(`android/build.gradle`) (中文(简体) ).
-   该插件使用克特林 2.2.20并解决了Media3通过Mux工艺品的中转.
-   Android apps 瞄准 SDK 33 或更新型的软件也会看到 `android.permission.POST_NOTIFICATIONS` 合并自此图书馆. 插件在运行时不请求通知; 显示的条目可以防止由 Mux 的 Glide 导致的 Android 失败 `NotificationTarget` 依赖性。 如果您的应用程序不需要该许可, 请用 :

```xml
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">
    <uses-permission
        android:name="android.permission.POST_NOTIFICATIONS"
        tools:node="remove" />
</manifest>
```

### 网络设置

-   插件捆绑 `@mux/mux-player` 并用全屏覆盖视频。 玩家会自动为桌面和移动浏览器注入近平价.

## API 密码

-   [`play(...)`](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-play)
-   [`dismiss()`](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-dismiss)
-   [`isActive()`](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-isactive)
-   [`removeAllListeners()`](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-removealllisteners)
-   [`addListener(E, ...)`](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-addlistenere-)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-interfaces)

### 播放(...)

```typescript
play(options: MuxPlayOptions) => Promise<void>
```

启动全屏原生的Mux玩家并开始回放.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[MuxPlayOptions](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-muxplayoptions)` |

* * *

### 开除()

```typescript
dismiss() => Promise<void>
```

显示时解散玩家 .

* * *

### 正态( A)

```typescript
isActive() => Promise<{ active: boolean; }>
```

返回当前显示的玩家 .

**回返情况:** `Promise<{ active: boolean; }>`

* * *

### 删除所有收听器( )

```typescript
removeAllListeners() => Promise<void>
```

删除插件实例上注册的所有事件听众 .

* * *

### 添加倾听器( E,...)

```typescript
addListener<E extends keyof MuxPlayerEvents>(eventName: E, listenerFunc: (event: MuxPlayerEvents[E]) => void) => Promise<PluginListenerHandle>
```

听从插件发布的玩家生命周期或回放事件 .

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `E` |
| **`listenerFunc`** | `(event: MuxPlayerEvents[E]) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capgo/capacitor-mux-player/#readme-pluginlistenerhandle)>`

* * *

### 接口

#### MuxPlay 选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`playbackId`** | `string` | 您想要流出的资产的回放ID . |
| **`playbackToken`** | `string` | 为已签名的回放策略提供 JSON 网络符号 . |
| **`drmToken`** | `string` | 为 DRM 回放策略提供 JSON 网络符 . |
| **`customDomain`** | `string` | 覆盖默认的Mux回放域(例如. `stream.example.com`) (中文(简体) ). |
| **`autoPlay`** | `boolean` | 玩家可见时自动播放. 默认为真. |
| **`startTime`** | `number` | 从提供的时间( 秒) 开始播放 . |
| **`poster`** | `string` | 提供在播放开始前显示的海报图像 URL . |
| **`title`** | `string` | 在本地玩家染色体中提供自定义的表面标题 . |
| **`subtitle`** | `string` | 提供字幕或描述到本地玩家的染色体中可用. |
| **`muted`** | `boolean` | 设定为真实, 以在播放开始时保持视频的静音 . |
| **`environmentKey`** | `string` | 用于分析的 Mux 数据环境密钥 。 如果省略,则使用SDK默认. |
| **`playerName`** | `string` | 为分析提供明确的玩家名称. 默认为生成的名称 . |
| **`enableSmartCache`** | `boolean` | 当基础 SDK 支持时启用智能缓存 . |
| **`debug`** | `boolean` | 启用本地 SDK 的动词记录 . |

#### 插件听筒

| Prop | 类型 |
| --- | --- |
| **`remove`** | `() => Promise<void>` |

#### MuxPlayer 活动

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`ready`** | `{ playerName?: string; }` | 当基础玩家准备好开始回放时被解除. |
| **`play`** | `void` | 回放开始或恢复时被解除 . |
| **`pause`** | `void` | 回放暂停时被放出. |
| **`ended`** | `void` | 回放结束时发射. |
| **`error`** | `{ message: string; }` | 当发生无法恢复的错误时被解除 . |
| **`playerDismissed`** | `void` | 全屏播放器关闭后被解除. |

| 方法 | 签署 | 说明 |
| --- | --- | --- |
| **获取 PluginVersion** | ()QQ承诺QQ版本:字符串;QQ | 获取本地 Capacitor 插件版本 |

## 常见问题

### @capgo/capacitor-mux-player 是什么？

本地 Mux Player SDK 在 IOS 和 Android 上播放视频

### 如何安装 @capgo/capacitor-mux-player？

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

### @capgo/capacitor-mux-player 支持 TypeScript 吗？

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

### @capgo/capacitor-mux-player 支持 ESM 还是 CommonJS？

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

### @capgo/capacitor-mux-player 可以商用吗？

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

### @capgo/capacitor-mux-player 的下载量有多少？

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

### @capgo/capacitor-mux-player 还在维护吗？

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