Class DeviceUtils

Hierarchy

DeviceUtils

Index

Constructors

Methods

assertSupported filterDevices getAvailableMediaDevices getDevicePermissions getSupportedConstraints isSupported

Constructors

constructor

new DeviceUtils(): DeviceUtils
Returns DeviceUtils

Methods

`Static` assertSupported

assertSupported(method): void
Parameters
- method: MediaDevicesFunc
Returns void
- Defined in src/helpers/deviceUtils.ts:30

`Static` filterDevices

filterDevices(devices, deviceKinds?, groupId?, deviceId?): MediaDeviceInfo[]
Parameters
- devices: MediaDeviceInfo[]
  
  Array of device descriptors
- deviceKinds: MediaDeviceKind[] = ...
  
  Filter for specific kinds of devices
- Optional groupId: string
  
  Filter by group. A groupId specifies devices belonging together, eg. camera and microphone of a single webcam
- Optional deviceId: string
  
  Filter by deviceId. Each device, cameras and microphones, has its unique id.
Returns MediaDeviceInfo[]
List of media device descriptors resulting
- Defined in src/helpers/deviceUtils.ts:114

`Static` getAvailableMediaDevices

getAvailableMediaDevices(audioVideoOnly?): Promise<MediaDeviceInfo[]>
Parameters
- Optional audioVideoOnly: TrackKind
  
  Restricts the permission probe to the given track kind, so e.g. a denied camera does not block enumerating audio devices in audio-only mode.
Returns Promise<MediaDeviceInfo[]>
- Defined in src/helpers/deviceUtils.ts:99

`Static` getDevicePermissions

getDevicePermissions(devices, onRejection?): Promise<MediaDevicePermissionResult[]>
Uses global Permissions API.
Parameters
- devices: MediaDeviceInfo[]
  
  Devices where to check permissions can be obtained for camera & microphone.
- Optional onRejection: ErrorCb
Returns Promise<MediaDevicePermissionResult[]>

See
https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API Get device permissions (checking only audioinput & videoinput kinds) on Chromium browsers for Desktop & Android. Use getUserMedia on Firefox and iOS.
- Defined in src/helpers/deviceUtils.ts:51

`Static` getSupportedConstraints

getSupportedConstraints(): MediaTrackSupportedConstraints
Returns MediaTrackSupportedConstraints
- Defined in src/helpers/deviceUtils.ts:39

`Static` isSupported

isSupported(method): boolean
Parameters
- method: MediaDevicesFunc
Returns boolean
- Defined in src/helpers/deviceUtils.ts:25

Generated using TypeDoc