API Documentation

for 0.0.1
Show:

UserMedia Class

UserMedia class give access to navigator.getUserMedia with various simplification of access

Methods

devicesFound

(
  • devices
)
private

Use internally to find the best device according to the infos given by the user

Parameters:

  • devices Object

    object given by the Promise launched by enumerateDevices()

off

()

Deactivate the component

on

()

Activates the component

openDevice

(
  • device
)
private

open the device that has been found by devicesFound()

Parameters:

  • device Object

    the device to open

setup

()

Set the UserMedia up.

streamError

(
  • err
)

Use in the getUserMedia promise to check errors

Parameters:

  • err String

Properties

audioDevices

Unknown

List of all available audio devices

audioStream

Unknown

the current device audio stream reference

canvas

Unknown

the prefortatted canvas element into which the video stream can be drawn. this canvas has the same size has the video stream

devices

Unknown

List of all available devices

deviceToOpen

Unknown private

the current device to be opened

streamCapabilities

Object

stream actual capabalities, for debugging purpose

streamSettings

Object

stream actual settings, for debugging purpose

videoDevices

Unknown

List of all available video devices

videoEl

Unknown

the video element to which the video stream is attached to

videoStream

Unknown

the current device video stream reference