Puff

Nodejs Cross-platform screen sharing addon with incredible performance. Written with C++.

This project still in development and only supports on Node.js or Electron based environment only. I'll extend supporting environment for Web based environment!

Installation

git clone https://github.com/async3619/Puff
cd ./Puff
npm install

or

npm install puff-screeny

Usage

var puff = require("puff");

// Call getAvailableWindows() to retrive captureable windows
// you can use getAvailableScreens if you want to capture Screen instead of Window.
var captureTargets = puff.getAvailableWindows();

Building

npm install # <-- if you haven't installed dependencies
npm run -- node-gyp build # <-- It just build addon only. not effects on dependencies.

Dependencies

This project needs CMake to build dependencies before build Puff module.

Supports

| Platform / OS | Windows | Linux | OS X | |--------------------------|:-------:|:-----:|:----:| | Electron | O | X | X | | Web Browser (Emscripten) | X | X | X |

Puff currently supports Electron and Windows environment only.

See Also: Support Table Information.

License

The project is licensed under the MIT License.

Copyright © 2017 TerNer ([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.