Merge pull request #42 from Picovoice/user-media-check

Author: laves

demo/package.json

@@ -17,7 +17,7 @@
   "author": "Picovoice Inc",
   "license": "Apache-2.0",
   "dependencies": {
-    "@picovoice/web-voice-processor": "^4.0.3",
+    "@picovoice/web-voice-processor": "^4.0.4",
     "http-server": "^14.0.0",
     "wavefile": "^11.0.0"
   }

demo/yarn.lock

@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@picovoice/web-voice-processor@^4.0.3":
-  version "4.0.3"
-  resolved "https://registry.yarnpkg.com/@picovoice/web-voice-processor/-/web-voice-processor-4.0.3.tgz#728b1e61ae027f2679796fda27040209ebeadf5b"
-  integrity sha512-4hUKRNMfdqIx74VPi8mwkow8yyLM1NsMWi+Ak2uxK213A+26R5Xr9ms99hkOuPrBMHCGl+Ffuo9QXmkGBjsbnQ==
+"@picovoice/web-voice-processor@^4.0.4":
+  version "4.0.4"
+  resolved "https://registry.yarnpkg.com/@picovoice/web-voice-processor/-/web-voice-processor-4.0.4.tgz#12140c9a0120e0db9dda80bcf00d7f827f1a8c99"
+  integrity sha512-WZ4PPXU0i/yPzIjd+jbx9VSMF6Shbyf2BXt2U7a6MASJ2KWeG9+zDx6nteDF10cyG3T78G+4EB24tLsdyLVmWw==
 
 ansi-styles@^4.1.0:
   version "4.3.0"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picovoice/web-voice-processor",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Real-time audio processing for voice, in web browsers",
   "entry": "src/index.ts",
   "module": "dist/esm/index.js",

src/index.ts

@@ -2,7 +2,7 @@ import './polyfill/audioworklet_polyfill';
 
 import { WvpMessageEvent, WebVoiceProcessorOptions } from './types';
 
-import { WebVoiceProcessor} from './web_voice_processor';
+import { WebVoiceProcessor, WvpError } from './web_voice_processor';
 import { browserCompatibilityCheck } from './utils';
 
 import { VuMeterEngine } from './engines/vu_meter_engine';
@@ -18,6 +18,7 @@ ResamplerWorker.setWasm(resamplerWasm);
 export {
   ResamplerWorker,
   VuMeterEngine,
+  WvpError,
   WebVoiceProcessor,
   WebVoiceProcessorOptions,
   WvpMessageEvent,

src/web_voice_processor.ts

@@ -1,5 +1,5 @@
 /*
-    Copyright 2018-2022 Picovoice Inc.
+    Copyright 2018-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
     file accompanying this source.
@@ -20,6 +20,16 @@ import { PvEngine, WebVoiceProcessorOptions, WvpState } from './types';
 
 import { AudioDumpEngine } from './engines/audio_dump_engine';
 
+/**
+ * WebVoiceProcessor Error Class
+ */
+export class WvpError extends Error {
+  constructor(name: string, message: string) {
+    super(message);
+    this.name = name;
+  }
+}
+
 /**
  * Obtain microphone permission and audio stream;
  * Down sample audio into 16kHz single-channel PCM for speech recognition (via ResamplerWorker).
@@ -167,21 +177,42 @@ export class WebVoiceProcessor {
     return new Promise((resolve, reject) => {
       this._mutex
         .runExclusive(async () => {
-          if (this._audioContext === null || this._state === WvpState.STOPPED || this.isReleased) {
-            const { audioContext, microphoneStream, recorderNode, resamplerWorker } = await this.setupRecorder(this._options);
-            this._audioContext = audioContext;
-            this._microphoneStream = microphoneStream;
-            this._recorderNode = recorderNode;
-            this._resamplerWorker = resamplerWorker;
-
-            recorderNode.port.onmessage = (event: MessageEvent): void => {
-              resamplerWorker.process(event.data.buffer[0]);
-            };
-            this._state = WvpState.STARTED;
-          }
-
-          if (this._audioContext !== null && this.isSuspended) {
-            await this._audioContext.resume();
+          try {
+            if (this._audioContext === null || this._state === WvpState.STOPPED || this.isReleased) {
+              const { audioContext, microphoneStream, recorderNode, resamplerWorker } = await this.setupRecorder(this._options);
+              this._audioContext = audioContext;
+              this._microphoneStream = microphoneStream;
+              this._recorderNode = recorderNode;
+              this._resamplerWorker = resamplerWorker;
+
+              recorderNode.port.onmessage = (event: MessageEvent): void => {
+                resamplerWorker.process(event.data.buffer[0]);
+              };
+              this._state = WvpState.STARTED;
+            }
+
+            if (this._audioContext !== null && this.isSuspended) {
+              await this._audioContext.resume();
+            }
+          } catch (error: any) {
+            if (error.name === 'SecurityError' || error.name === 'NotAllowedError') {
+              throw new WvpError(
+                'PermissionError',
+                'Failed to record audio: microphone permissions denied.'
+              );
+            } else if (error.name === 'NotFoundError') {
+              throw new WvpError(
+                'DeviceMissingError',
+                'Failed to record audio: audio recording device was not found.'
+              );
+            } else if (error.name === 'NotReadableError') {
+              throw new WvpError(
+                'DeviceReadError',
+                'Failed to record audio: audio recording device is not working correctly.'
+              );
+            } else {
+              throw error;
+            }
           }
         })
         .then(() => {