Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CameraAccess

A helper object to interact with cameras.

Index

Functions

Functions

getCameras

  • getCameras(refreshDevices?: boolean): Promise<Camera[]>
  • Get a list of cameras (if any) available on the device, a camera access permission is requested to the user the first time this method is called if needed.

    If the browser is incompatible the returned promise is rejected with a UnsupportedBrowserError error.

    When refreshing available devices, if updated deviceId information is detected, cameras' deviceId are updated accordingly. This could happen after a camera access and stop in some situations.

    Parameters

    • Default value refreshDevices: boolean = false

      Force a call to refresh available devices via navigator.mediaDevices.enumerateDevices() even when information is already available.

    Returns Promise<Camera[]>

    A promise resolving to the array of available Camera objects (could be empty).

Generated using TypeDoc