Generic-rrweb-recorder is a tool to record the dom of a web page as well as the sound of the microphone.
The advantage compared to a video?
You can copy/paste the text, and the files are extremely light!
Test it here
If you want to know how it works under the hood, please see this doc
This repo is using submodules.
Do not forget to clone the repo using --recursive option
git clone --recursive https://github.com/Telecom-Paris/generic-rrweb-recorder.git
To test it, you need to use a server, due to security reasons.
Just include a line in the header of your website :
(or at the bottom of the body if you want your website to load faster)
<script type="text/javascript" src="path/to/recorder.js"></script>
If you are looking for the minified version, it can be found under the min folder. To include the minified version, you can use:
<script type="text/javascript" src="path/to/recorder.min.js"></script>
See here for more info about the minified version.
First, you need to create a new recorder Object:
let myRecorder = new Recorder();
If you want to load the scripts required by the recorder:
myRecorder.loadScripts();
If you do not want to handle this, the startRecord() function handles it for you.
This option is only available if you want to load those scripts directly after your webpage.
To start a record:
myRecorder.startRecord();
To pause a record:
myRecorder.pauseRecord();
To resume a record:
myRecorder.resumeRecord();
To stop a record:
myRecorder.stopRecord();
To dowbload a record as a zip file:
myRecorder.downRecord();
To build the documentation, you need jsdoc.
Once installed, you can build the documentation using:
jsdoc srcs/*.js README.md -d docs/generated-doc/
You will find it under the docs folder, in HTML format. (here) You can also find answers to common questions here
This project use the following libraries: