# @gumlet/react-embed-player 中文文档

规范地址：https://npmcn.com/package/%40gumlet/react-embed-player/

版本：2\.1\.1
npm 元数据更新时间：2026-03-14T04:40:44.355Z
中文译文更新时间：2026-11-17T04:25:41.888Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40gumlet/react-embed-player
原文对照：https://npmcn.com/package/%40gumlet/react-embed-player/?lang=original
项目主页：https://github.com/gumlet/react-embed-player#readme
源码仓库：https://github.com/gumlet/react-embed-player

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

- 包体积（解压后）：38.1 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^19\.1\.0，react-dom ^19\.1\.0
- 首次发布：2024-08-05T13:19:06.476Z
- 最新版本发布：2026-03-14T04:40:43.921Z
- 近 30 天下载量：6598（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 2 个）

## 中文简介

Gumlet 重现嵌入式玩家

## 安装

```sh
npm install @gumlet/react-embed-player
```

也可以使用：`pnpm add @gumlet/react-embed-player`、`yarn add @gumlet/react-embed-player`、`bun add @gumlet/react-embed-player`

## README

# 反应- 嵌入式玩家

> 胶囊嵌入播放器在反应中

[![NPM](https://img.shields.io/npm/v/@gumlet/react-embed-player.svg)](https://www.npmjs.com/package/@gumlet/react-embed-player) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com/)

## 安装

```bash
npm install --save @gumlet/react-embed-player
```

## 使用量

```jsx
import React, { Component } from 'react'

import {GumletPlayer} from '@gumlet/react-embed-player'

class Example extends Component {
  render() {
    return <GumletPlayer
      videoID="64bfb0913ed6e5096d66dc1e"
      title="Gumlet Player Example"
      style={{height: "100vh", width: "100vw", position:"relative"}}
      schemaOrgVideoObject={{"@context":"https://schema.org","@type":"VideoObject","name":"Gumlet","description":"","embedUrl":"https://play.gumlet.io/embed/64bfb0913ed6e5096d66dc1e"}}
      autoplay={false}
      preload={false}
      muted={true}
    />
  }
}
```

## 道具

| Prop | 说明 | 默认 |
| --- | --- | --- |
| 视频ID `String` `Required` | 用口香糖处理视频后生成的视频ID |  |
| 活 动 `Boolean` | 视频是否为活流 | 虚假 |
| 标题 `String` | 框架的标题 | Gumlet 视频播放器 |
| 样式 `Object` | 样式标记传递到 Iframe 容器 | {打字:"56.25% 0 0",位置:"相对"} |
| 计划OrgVideo 对象 `Object` | 添加到脚本标签中的 schema.org 对象 | {} |
| 自动播放 `Boolean` | 视频是否应该自动播放 | 收藏设置中的默认设置 |
| 预装 `Boolean` | 如果视频预装 | 收藏设置中的默认设置 |
| 哑巴 `Boolean` | 视频播放器是否关闭 | 收藏设置中的默认设置 |
| gm 用户 id `String` | 用户代号传递给口香糖透视对象 | 无效 |
| gm 用户 名称 `String` | 用户名传递给 gumlet 透视对象 | 无效 |
| gm 用户 电子邮件 `String` | 用户电子邮件传递给 gumlet 透视对象 | 无效 |
| gm 自定义 数据 1 `String` | 自定义数据 1 传递给口香糖洞见对象 | 无效 |
| 循环 `Boolean` | 视频应该循环播放 | 收藏设置中的默认设置 |
| 驱动程序( t) `String` | DRM 保护内容的后端生成了token | 无效 |
| 过期 `Integer` | 对 DRM 保护内容从 millis 时代开始的过期时间 | 无效 |
| 宽度( tag url) `String` | URL 编码 VAST 标签 URL | 无效 |
| 开始( h) `Boolean` | 以最高分辨率启动视频 | 虚假 |
| 禁用搜索( s) `Boolean` | 禁用搜索栏并删除前方并倒转按钮 | 虚假 |
| 禁用 player 控件 `Boolean` | 从玩家中删除所有玩家控件 | 虚假 |
| 水标记( t) `String` | 在玩家中显示的水印文字 | 无效 |
| facebook 像素 id `String` | 用于发送回放数据的 Facebook 像素ID | 无效 |
| ga tracking id (中文(简体) ) `String` | Google 像素ID 用于发送关于播放的数据 | 无效 |
| 页:1 `Integer` | 回放瞬间数秒开始视频 | 无效 |
| 启用 播放器 控制 `Array` | 只允许显示 eplayer 控件 | 无效 |

## 方法

`play`无效 播放媒体:

`pause`无效 暂停媒体:

`getPaused`:布尔 确定媒体是否被暂停 :

`mute`无效 压制媒体:

`unmute`无效 揭发媒体:

`getMuted`:布尔 确定媒体是否变音 :

`setVolume`无效 设出出卷. 值必须在 0- 100 之间 :

`getVolume`编号 取出音量来. 数值为 0- 100 :

`getDuration`编号 获取媒体持续时间为秒:

`setCurrentTime`编号 以秒计执行特定时间的搜索 :

`getCurrentTime`编号 获取视频秒的当前时间 :

`setPlaybackRate`编号 设定播放器中可用的播放率 。 如果无法使用已通过的回放速率, 不返回错误 .

`getPlaybackRate`编号 获取玩家当前播放率 :

## 回电

唤回能入听.

`onReady` 视频准备好就开火了.

`onProgress` 当视频装入更多重播媒体时点火 :

```js
{
  percent: 0.8,
}
```

`onTimeupdate` 回放时起火 :

```js
{
  seconds: 10,
  duration: 40
}
```

`onPlay` 视频开始播放时开火.

`onPause` 视频暂停时开火.

`onEnded` 视频完成后开火.

`onFullScreenChange` 当视频全屏更改时起火:

```js
{
  isFullScreen: true // or false
}
```

`onPipChange` 当视频被放入或从图片中带回时起火.

```js
{
  isPIP: true // or false
}
```

`onPlaybackRateChange` 当用户更改视频回放率时起火.

`onAudioChange` 当视频的音频音轨被改变时点火.

`onQualityChange` 当视频质量改变时点火.

`onVolumeChange` 当玩家的音量级别被改变时会起火. 玩家被哑音或未被哑音时也会被炒作,同时会分别被哑音和未被哑音事件所炒作.

```js
{
  volume: 50
}
```

`onSeeked` 当视频被用户搜索时会起火. 以秒数和视频总长度计算的时间.

```js
{
  seconds: 10
  duration: 50
}
```

`onError` 发生错误时起火.

## 维护者

这个图书馆由 [口香糖](https://github.com/gumlet)

## 常见问题

### @gumlet/react-embed-player 是什么？

Gumlet 重现嵌入式玩家

### 如何安装 @gumlet/react-embed-player？

在项目目录运行 npm install @gumlet/react-embed-player，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.1\.0）、react-dom（^19\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gumlet/react-embed-player 支持 TypeScript 吗？

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

### @gumlet/react-embed-player 支持 ESM 还是 CommonJS？

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

### @gumlet/react-embed-player 可以商用吗？

@gumlet/react-embed-player 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @gumlet/react-embed-player 的下载量有多少？

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

### @gumlet/react-embed-player 还在维护吗？

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

