Socket
Socket
Sign inDemoInstall

get-user-media-promise

Package Overview
Dependencies
0
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    get-user-media-promise

Light-weight wrapper for the newer Promise-based MediaDevices.getUserMedia API with a fallback to navigator.getUserMedia (and it's prefixed variants)


Version published
Weekly downloads
2.3K
decreased by-11.05%
Maintainers
1
Install size
12.5 kB
Created
Weekly downloads
 

Readme

Source

get-user-media-promise

Build Status npm-version bower-version

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 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 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 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:

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:

console.log(getUserMedia.isSupported);

Keywords

FAQs

Last updated on 30 Apr 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc