https://github.com/otalk/getScreenMedia

A browser module for attempting to get access to a MediaStream of a user's screen. With a nice node-like API.
https://github.com/otalk/getScreenMedia

Last synced: 4 months ago
JSON representation

A browser module for attempting to get access to a MediaStream of a user's screen. With a nice node-like API.

• Host: GitHub
• URL: https://github.com/otalk/getScreenMedia
• Owner: otalk
• Created: 2013-06-28T22:56:30.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2019-02-27T17:36:13.000Z (almost 6 years ago)
• Last Synced: 2024-10-28T22:43:14.171Z (4 months ago)
• Language: JavaScript
• Size: 127 KB
• Stars: 154
• Watchers: 15
• Forks: 83
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# getScreenMedia

## What is this?

A tiny browser module that gives us a simple API for getting access to a user's screen.

It gives us a cleaner node.js-style, error-first API and cross-browser handling. No browser support checking necessary; lack of support is treated in the same way as when the user rejects the request: the callback gets passed an error as the first argument.

Suitable for use with browserify/CommonJS on the client.

## Installing

```

npm install getscreenmedia

```

## How to use it

First build and install a domain-specific extension for [Chrome](https://github.com/otalk/getScreenMedia/tree/master/chrome-extension-sample). Firefox and Microsoft Edge will work out of the box.

Use the snippet below to get a screen stream, similar to [getUserMedia](https://github.com/otalk/getUserMedia).

```js

var getScreenMedia = require('getscreenmedia');

getScreenMedia(function (err, stream) {

    // if the browser doesn't support user media

    // or the user says "no" the error gets passed

    // as the first argument.

    if (err) {

       console.log('failed');

    } else {

       console.log('got a stream', stream);  

    }

});

```

## Why?

All supported browsers require the use of an extension and don't offer an cross-browser API which is annoying and error-prone. Node-style (error-first) APIs that are cross-browser, installable with npm and runnable on the client === win!

## Error handling

Error handling (denied requests, etc) are handled mostly by the underlying [getUserMedia lib](https://github.com/HenrikJoreteg/getUserMedia). However this adds one more error type:

- `"HTTPS_REQUIRED"`

Because that's a current requirement of Chrome.

See the [handling errors section of the getUserMedia lib](https://github.com/HenrikJoreteg/getUserMedia#handling-errors-summary) for details about how errors are handled.

## License

MIT

The Firefox sample extension is licensed under MPL 2.0

## Created By

If you like this, follow: [@HenrikJoreteg](http://twitter.com/henrikjoreteg) on twitter.