78935ea820
* first commit * rrvideo v0.1.0 First version of rrvideo. 1. Use as a Node.JS lib. 2. Use as a CLI. Features are implemented via puppeteer, ffmpeg and rrweb-player. * add readme * update publish script * add node env in cli file and change package.json bin to same like README (#4) Co-authored-by: Xu Yinjie <xuyinjie@xiaobangtouzi.com> * release 0.2.0 * fix #6 avoid assign undefined to config * Fix: Solve the inconsistency between rrvideo and the real recorded page rendering when rendering the page with a headless browser (https://github.com/rrweb-io/rrvideo/pull/26) Author: xujiujiu <906784584@qq.com> --------- Co-authored-by: xujiujiu <906784584@qq.com> * refactor rrvideo 1. refactor code 2. change monorepo config 3. remove separate TS dependencies * add changeset * fix: eslint errors --------- Co-authored-by: Yanzhen Yu <yanzhen@smartx.com> Co-authored-by: xyj <593500664@qq.com> Co-authored-by: Xu Yinjie <xuyinjie@xiaobangtouzi.com> Co-authored-by: xujiujiu <906784584@qq.com>
36 lines
971 B
Markdown
36 lines
971 B
Markdown
# rrvideo
|
||
|
||
rrvideo 是用于将 [rrweb](https://github.com/rrweb-io/rrweb) 录制的数据转为视频格式的工具。
|
||
|
||
## 安装 rrvideo
|
||
|
||
1. 安装 [ffmpeg](https://ffmpeg.org/download.html)。
|
||
2. 安装 [Node.JS](https://nodejs.org/en/download/)。
|
||
3. 执行 `npm i -g rrvideo` 以安装 rrvideo CLI。
|
||
|
||
## 使用 rrvideo
|
||
|
||
### 将一份 rrweb 录制的数据（JSON 格式）转换为视频。
|
||
|
||
```shell
|
||
rrvideo --input PATH_TO_YOUR_RRWEB_EVENTS_FILE
|
||
```
|
||
|
||
运行以上命令会在执行文件夹中生成一个 `rrvideo-output.mp4` 文件。
|
||
|
||
### 指定输出路径
|
||
|
||
```shell
|
||
rrvideo --input PATH_TO_YOUR_RRWEB_EVENTS_FILE --output OUTPUT_PATH
|
||
```
|
||
|
||
### 对回放进行配置
|
||
|
||
通过编写一个 rrvideo 配置文件再传入 rrvideo CLI 的方式可以对回放进行一定的配置。
|
||
|
||
```shell
|
||
rrvideo --input PATH_TO_YOUR_RRWEB_EVENTS_JSON_FILE --config PATH_TO_YOUR_RRVIDEO_CONFIG_FILE
|
||
```
|
||
|
||
rrvideo 配置文件可参考[示例](./rrvideo.config.example.json)。
|