https://github.com/nfriedly/get-user-media-promise

Basic wrapper for navigator.mediaDevices.getUserMedia with automatic fallback to navigator.getUserMedia
https://github.com/nfriedly/get-user-media-promise

Last synced: about 2 months ago
JSON representation

Basic wrapper for navigator.mediaDevices.getUserMedia with automatic fallback to navigator.getUserMedia

• Host: GitHub
• URL: https://github.com/nfriedly/get-user-media-promise
• Owner: nfriedly
• Created: 2016-03-08T15:33:59.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-17T03:09:23.000Z (6 months ago)
• Last Synced: 2024-05-02T00:03:20.195Z (5 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/get-user-media-promise
• Size: 514 KB
• Stars: 22
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# get-user-media-promise

[![CI](https://github.com/nfriedly/get-user-media-promise/actions/workflows/ci.yml/badge.svg)](https://github.com/nfriedly/get-user-media-promise/actions/workflows/ci.yml)

[![npm-version](https://img.shields.io/npm/v/get-user-media-promise.svg)](https://www.npmjs.com/package/get-user-media-promise)

![bower-version](http://badge.fury.io/bo/get-user-media-promise.svg)

Light-weight Ponyfill/Polyfill for [navigator.mediaDevices.getUserMedia] (the newer newer [Promise]-based API). Wraps the older callback-based [navigator.getUserMedia] when necessary.

Behaves as a ponyfill (doesn't touch globals) when used via browserify/webpack/etc. or as a polyfill (sets globals) when included as a standalone library.

Less than 0.5kb after minification and gzipping (about 5% of the size of the [other] getUserMedia shim).

**Note**: this will only work in web browsers, and only [fairly current ones](http://caniuse.com/#feat=stream) at that. 

Additionally, this library does not attempt to reformat constraints for cross-browser support, so if you need advanced audio/video constraints, the [other library][other] may be a better choice.

## Installation:

### npm

    npm install --save get-user-media-promise

    

### Bower

    bower install --save get-user-media-promise

    

### Standalone

 

 Download the [latest release][releases] from GitHub.

## Usage: 

 * With a bundler such as Require.js, Browserify, or WebPack: require() the module and it returns a `getUserMedia()` method that will always return a Promise or Promise-like object.

 * As a standalone library: when neither `define()` nor `module` are defined, the module will go into polyfill mode, setting `navigator.mediaDevices.getUserMedia()` if that method is not already defined or doing nothing if it is.

 

 Then:

 

```js

var getUserMedia = require('get-user-media-promise'); // or navigator.mediaDevices.getUserMedia when used standalone

getUserMedia({audio: true, video: true})

  .then(function(mediaStream) {

    console.log(mediaStream);

  })

  .catch(function(error) {

    console.log('error');

  });

```

Check browser support ahead of time via the `isSupported` property:

```js

console.log(getUserMedia.isSupported);

```

[navigator.mediaDevices.getUserMedia]: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia

[Promise]: https://developer.mozilla.org/en-US/docs/Web/API/Promise

[navigator.getUserMedia]: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getUserMedia

[other]: https://www.npmjs.com/package/getusermedia

[releases]: https://github.com/nfriedly/get-user-media-promise/releases