Skip to content

hackergrrl/screen-stream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

screen-stream

Provides a video stream of your computer's display.

js-standard-style

Install

npm install screen-stream

You will also need ffmpeg installed and accessible from the command line.

Linux only so far! :O

CLI Usage

Remember to install globally so you can access the screen-stream command:

$ npm install -g screen-stream

Then freely pipe the stream anywhere!

$ screen-stream > recording.mp4
^C

$ mplayer recording.mp4

API

screen-stream exports a single method, which creates a new live stream of your display.

Stream your live screen to e.g. an HTTP endpoint!

var screen = require('screen-stream')
var request = require('request')

screen().pipe(request.put("http://my.website.com/live_stream_feed"))

Limitations

  • Linux support only so far
  • Requires a pre-existing ffmpeg install that's setup on your command line
  • No way to customize output (size, bitrate, format, etc)

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please use standard Javascript in your pull requests.

About

📹 Get a video stream of your computer's display.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published