https://github.com/lightsofapollo/x-recorder
Node based bin and library to capture X11 output
https://github.com/lightsofapollo/x-recorder
Last synced: about 1 year ago
JSON representation
Node based bin and library to capture X11 output
- Host: GitHub
- URL: https://github.com/lightsofapollo/x-recorder
- Owner: lightsofapollo
- License: mit
- Created: 2012-06-03T19:03:36.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2012-06-03T23:55:54.000Z (about 14 years ago)
- Last Synced: 2025-03-25T17:13:54.156Z (over 1 year ago)
- Language: JavaScript
- Size: 114 KB
- Stars: 42
- Watchers: 1
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# X-Recorder
Inspired by headless (the ruby gem) X-Recorder provides utils to
start Xvfb and record (as in video recording) X11 output based on a X DISPLAY id.
Primarily designed to be used as a bin its backed by a library you can use inside other node
libaries.
## Install
````sh
npm install x-recorder -g
````
## Comands
See `x-recorder --help` for an up to date list of sub commands.
### capture
Captures output of a shell script. Will create an Xvfb instance and run your script inside it
capturing the X Display via ffmpeg.
This command is useful in a CI environemnt where you want to capture the output of you
test command. The exit status, stdout, stderr output will be exactaly the same as the command
given in -s.
````sh
x-recorder capture -s "firefox google.com" -o $PWD/foo.mov
````
### start-xvfb
Starts Xvfb instance finds an available DISPLAY id.
Will echo display ID back to you.
````sh
x-recorder start-xvfb
````
### stop-xvfb
Stops Xvfb instance. Looks up its pid via /tmp/.X{ID}-lock
````sh
x-recorder stop-xvfb --display :99
````
### start-video
Records video from an already running DISPLAY.
````sh
x-recorder start-video --display :99 --pid $PWD/video.pid --output $PWD/out.mov
````
### stop-video
Stops video recording.
````sh
x-recorder stop-video --pid $PWD/video.pid
````
## LICENSE
MIT - See LICENSE.md