https://github.com/otalk/getUserMedia

Cross-browser getUserMedia shim with a node.js style error-first API
https://github.com/otalk/getUserMedia

Last synced: 4 months ago
JSON representation

Cross-browser getUserMedia shim with a node.js style error-first API

• Host: GitHub
• URL: https://github.com/otalk/getUserMedia
• Owner: otalk
• Archived: true
• Created: 2013-06-28T05:43:38.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-02-07T16:48:09.000Z (almost 8 years ago)
• Last Synced: 2024-08-11T19:23:43.261Z (4 months ago)
• Language: JavaScript
• Size: 78.1 KB
• Stars: 233
• Watchers: 13
• Forks: 43
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# getUserMedia

## What is this?

A tiny browser module that gives us a simple API for getting access to a user's camera or microphone by wrapping the `navigator.getUserMedia` API in modern browsers.

This is important because as of right now, all browsers return errors differently. More on that below.

This lib also gracefully handles the lack of support in a browser. So you never have to check first (see error handling below).

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. 

If you're not using browserify or you want AMD support use `getusermedia.bundle.js`. Note that if no module system is detected it simply attaches a function called `getUserMedia` to `window`.

## Installing

```

npm install getusermedia

```

## How to use it

With this helper it's clean/simple to get access to a user's camera, mic, etc.

```js

var getUserMedia = require('getusermedia');

getUserMedia(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);  

    }

});

```

Passing in options is optional. It defaults to `{video: true, audio: true}`;

```js

// optionally pass constraints as the first argument

// they just passed through.

getUserMedia({video: true, audio: false}, function (err, stream) { ... });

```

## Why? Because it's super ugly without this tool

```js

// first deal with browser prefixes

var getUserMedia = navigator.getUserMedia || 

    navigator.mozGetUserMedia || 

    navigator.webkitGetUserMedia;

// make sure it's supported and bind to navigator

if (getUserMedia) {

    getUserMedia = getUserMedia.bind(navigator);

} else {

    // have to figure out how to handle the error somehow

}

// then deal with a weird, positional error handling API

getUserMedia(

    // media constraints

    {video: true, audio: true}, 

    // success callback

    function (stream) {

        // gets stream if successful

    }, 

    // error callback

    function (error) {

        // called if failed to get media

    }

)

```

## Handling errors (summary)

All failed calls to `getusermedia` in this library will return an error object (of type `NavigatorUserMediaError`) as the first argument to the callback. All will have a `.name` according to [the specification](http://w3c.github.io/mediacapture-main/getusermedia.html#mediastreamerror)

## License

MIT

## Created By

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