Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

getusermedia-async

catcher-in-the-try9Unlicense1.0.0

A promise-based, awaitable, browser-independent getUserMedia function to get user's audio or video.

getusermedia, web-speech-api, web, speech, api, ios, android, chrome, safari, media, html5, audio, video, speech, api, speech-api, speech, speech, recognition

readme

Asynchronous, browser-independent wrapper for the getUserMedia function.

Short sample

var getUserMedia = require('getusermedia-async').getUserMedia;
var audioStreamPromise = getUserMedia({ video: false, audio: true});
// OR:
var audioStream = await getUserMedia({ video: false, audio: true});

What's it for?

This is a promise-based, awaitable, browser-independent getUserMedia function to get user's audio or video.

It is based on the getusermedia package by Henrik Joreteg which actually does most of the job.

Methods

  • getUserMedia(options): returns a stream, or throws a NavigatorUserMediaError. options include two boolean properties: audio (default: true) and video (default: true).
  • getUserAudio(): shortcut to getUserMedia({ audio: true, video: false }).

Example:

var getUserAudio = require('getusermedia-async').getUserAudio;
var audioStreamPromise = getUserAudio();

Comments and suggestions

If you have any comments, contact me here: https://github.com/catcher-in-the-try/