配方
你可能还想阅读指南来了解这些 API,或阅读内部设计文档以了解 rrweb 的更多技术细节。
场景
录制与回放
录制与回放是最常见的使用场景,适用于任何需要收集用户行为并进行回放的场景。
异步加载事件
当录制的事件数据量增大时,在单次请求中加载全部事件的性能不佳。你可以对事件进行分页,按需加载。
实时回放(实时模式)
如果你想以实时方式回放事件,可以使用实时模式 API。该 API 也适用于一些实时协作场景。
自定义事件
你可能需要在录制 rrweb 事件的同时记录一些自定义事件,并让它们像其他事件一样被回放。自定义事件 API 正是为此而设计的。
回放期间与 UI 交互
默认情况下,回放期间 UI 无法交互。但你可以通过 API 以编程方式启用/禁用交互。
自定义回放器
当 Replayer 和 rrweb-player 的 UI 无法满足你的需求时,你可以定制自己的回放器 UI。
转换为视频
rrweb 录制的事件数据是一种高性能、易于压缩的文本格式,回放也是像素级精确的。
但如果你确实需要将其转换为视频格式,也有一些工具可以完成这项工作。
优化存储体积
在某些应用中,rrweb 可能会录制超出预期的数据量。本部分将帮助你找到合适的方式来优化存储。
Canvas
Canvas 是一种特殊的 HTML 元素,rrweb 默认不会录制它。针对 Canvas 的录制与回放,有一些可选方案。
Console 录制器与回放器
从 v1.0.0 开始,我们添加了用于录制和回放 console 输出的插件。 该功能旨在为开发者提供关于 bug 现场的更多信息。针对 console 输出的录制与回放,有一些可配置选项。
插件 API
插件 API 旨在扩展 rrweb 的功能,同时不影响核心包的正常使用。