MediaDeviceFailure

Defined in: client-sdk-js/src/utils/deviceFailure.ts:22

Utility class for determining the type of media device failure from an error object.

Example

try {
  await createLocalAudioTrack();
} catch (e) {
  const failure = MediaDeviceFailure.getFailure(e);
  if (failure === 'PermissionDenied') {
    // show permission dialog
  }
}

Constructors

Constructor

new MediaDeviceFailure(): MediaDeviceFailure;

Returns

MediaDeviceFailure

Methods

getFailure()

static getFailure(error): DeviceFailureKind | undefined;

Defined in: client-sdk-js/src/utils/deviceFailure.ts:30

Determine the failure kind from a caught error.

Parameters

error

any

The error thrown by getUserMedia or similar APIs.

Returns

DeviceFailureKind | undefined

The categorised failure, or undefined if the error is not a recognised device failure.