# @amplitude/rrweb-player 中文文档

规范地址：https://npmcn.com/package/%40amplitude/rrweb-player/

版本：2\.1\.6
npm 元数据更新时间：2026-11-05T03:06:32.142Z
中文译文更新时间：2026-11-06T01:23:58.098Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：8.2 MB，18 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2023-10-24T15:05:06.227Z
- 最新版本发布：2026-11-05T03:06:31.736Z
- 近 30 天下载量：15436（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 14 个）

## 中文简介

rrweb 的 UI 更新器

## 安装

```sh
npm install @amplitude/rrweb-player
```

也可以使用：`pnpm add @amplitude/rrweb-player`、`yarn add @amplitude/rrweb-player`、`bun add @amplitude/rrweb-player`

## README

_在找Vue.js的版本吗? 转到这里 -- > [@preflight-hq/rrweb-player-vue (英语)](https://github.com/Preflight-HQ/rrweb-player-vue)_

* * *

# 网络播放器

由于 rrweb 的 replayer 仅提供基本的 UI, 您可以选择 rrweb 的 replayer , 它基于 rrweb 的 公共 API , 但具有 特性丰富的 replayer UI .

## 这跟以前有什么不同 `rrweb.Replayer`? 吗?

rrweb-player在引擎盖下使用rrweb's Replayer,但由于Replayer没有包含任何用于控制的UI,rrweb-player添加了这些.

## 安装

rrweb-player 也可以包含其中 `<script>`数字 :

```html
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/index.umd.cjs"></script>
```

或通过使用国家预防机制安装:

```shell
npm install --save rrweb-player
```

```js
import rrwebPlayer from 'rrweb-player';
import 'rrweb-player/dist/style.css';
```

## 使用量

```js
new rrwebPlayer({
  target: document.body, // customizable root element
  props: {
    events,
  },
});
```

## 选项

| 键 | 默认 | 说明 |
| --- | --- | --- |
| 事件 | \[ | 用于重放的事件 |
| 宽度 | 第1024号 | 重排层的宽度 |
| 高度 | 576个 | 递解器的高度 |
| 最大比例 | 1个 | 重排器的最大比例(1=100%),无限设定为0 |
| 自动播放 | 真实 | 是否自动播放 |
| 速度 | 1个 | 默认播放速度 |
| 速度选项 | \[1、2、4、8\] | 用户界面中的速度选项 |
| 显示控制器 | 真实 | 是否显示控制器 UI |
| 标记 | {} | 用密钥值映射自定义事件样式 |
| 不活动颜色 | #D4D4D4 请检查URL=值 (帮助) | 使用有效的 CSS 颜色字符串自定义进度栏中非活动时段指标的颜色 . |
| . | \- 说吧 | 这些 [rrweb 复制器选项](https://github.com/rrweb-io/rrweb/blob/master/guide.md#options-1) 将被绕过 |

## rwebPlayer 组件上的方法

```ts
addEventListener(event: string, handler: (params: any) => unknown): void;
```

```ts
addEvent(event: eventWithTime): void;
```

```ts
getMetaData() => {
    startTime: number;
    endTime: number;
    totalTime: number;
}
```

```ts
getReplayer() => Replayer;
```

```ts
getMirror() => Mirror;
```

在游戏/暂停之间切换

```ts
toggle();
```

设定播放器的速度

```ts
setSpeed(speed: number)
```

打开/ 关闭跳过不活动

```ts
toggleSkipInactive();
```

触发器调整大小, 当您更改宽度/ 高度时执行此任务

```ts
triggerResize();
```

重放游戏

```ts
play();
```

暂停重放

```ts
pause();
```

到一个时间点,暂停或演奏从那时开始

```ts
goto(timeOffset: number, play?: boolean)
```

播放时间和(可选)循环

```ts
playRange(
    timeOffset: number,
    endTimeOffset: number,
    startLooping: boolean = false,
    afterHook: undefined | (() => void) = undefined,
  )
```

## 常见问题

### @amplitude/rrweb-player 是什么？

rrweb 的 UI 更新器

### 如何安装 @amplitude/rrweb-player？

在项目目录运行 npm install @amplitude/rrweb-player，或使用 pnpm add / yarn add / bun add。

### @amplitude/rrweb-player 支持 TypeScript 吗？

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

### @amplitude/rrweb-player 支持 ESM 还是 CommonJS？

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

### @amplitude/rrweb-player 可以商用吗？

@amplitude/rrweb-player 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @amplitude/rrweb-player 的下载量有多少？

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

### @amplitude/rrweb-player 还在维护吗？

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

