videomail-client 13.14.1 → 13.15.1

package/dist/cjs/index.cjs

@@ -10876,7 +10876,7 @@ var __webpack_exports__ = {};
     var client = __webpack_require__(5734);
     var client_default = /*#__PURE__*/ __webpack_require__.n(client);
     var package_namespaceObject = {
-        rE: "13.14.1"
+        rE: "13.15.1"
     };
     function isAudioEnabled(options) {
         return Boolean(options.audio.enabled);
@@ -17026,6 +17026,20 @@ var __webpack_exports__ = {};
         "volumechange"
     ];
     const mediaEvents = MEDIA_EVENTS;
+    const VIRTUAL_KEYWORDS = [
+        "obs",
+        "virtual",
+        "manycam",
+        "vcam",
+        "splitcam",
+        "droidcam"
+    ];
+    function isVirtualCamera(videoTrack) {
+        const capabilities = videoTrack.getCapabilities();
+        if (!capabilities.frameRate) return true;
+        return VIRTUAL_KEYWORDS.some((keyword)=>videoTrack.label.toLowerCase().includes(keyword));
+    }
+    const util_isVirtualCamera = isVirtualCamera;
     function userMedia_define_property(obj, key, value) {
         if (key in obj) Object.defineProperty(obj, key, {
             value: value,
@@ -17096,6 +17110,7 @@ var __webpack_exports__ = {};
             this.onPlayReached = false;
             this.onLoadedMetaDataReached = false;
             this.playingPromiseReached = false;
+            this.videoTrackLabel = void 0;
             if (isAudioEnabled(this.options)) null != this.audioRecorder || (this.audioRecorder = new media_AudioRecorder(this, this.options));
             const unloadAllEventListeners = ()=>{
                 var _this_rawVisualUserMedia, _this_rawVisualUserMedia1;
@@ -17193,12 +17208,19 @@ var __webpack_exports__ = {};
             try {
                 var _this_rawVisualUserMedia, _this_rawVisualUserMedia1, _this_rawVisualUserMedia2;
                 const videoTrack = media_getFirstVideoTrack(localMediaStream);
-                if (videoTrack) if (videoTrack.enabled) {
+                this.videoTrackLabel = null == videoTrack ? void 0 : videoTrack.label;
+                if (videoTrack) if (videoTrack.enabled) if (util_isVirtualCamera(videoTrack)) throw error_createError({
+                    message: "Virtual cameras are not allowed.",
+                    explanation: `Please use a real camera, not "${videoTrack.label}".`,
+                    options: this.options
+                });
+                else {
                     let description = "";
-                    if (videoTrack.label && videoTrack.label.length > 0) description = description.concat(videoTrack.label);
+                    if (videoTrack.label.length > 0) description = description.concat(videoTrack.label);
                     description = description.concat(` with enabled=${videoTrack.enabled}, muted=${videoTrack.muted}, readyState=${videoTrack.readyState}`);
                     this.options.logger.debug(`UserMedia: ${videoTrack.kind} detected. ${description}`);
-                } else throw error_createError({
+                }
+                else throw error_createError({
                     message: "Webcam is disabled",
                     explanation: "The video track seems to be disabled. Enable it in your system.",
                     options: this.options
@@ -17217,6 +17239,9 @@ var __webpack_exports__ = {};
                 });
             }
         }
+        getVideoTrackLabel() {
+            return this.videoTrackLabel;
+        }
         isReady() {
             var _this_rawVisualUserMedia;
             return Boolean(null == (_this_rawVisualUserMedia = this.rawVisualUserMedia) ? void 0 : _this_rawVisualUserMedia.src);
@@ -17323,7 +17348,7 @@ var __webpack_exports__ = {};
             };
         }
         constructor(recorder, options){
-            super("UserMedia", options), userMedia_define_property(this, "recorder", void 0), userMedia_define_property(this, "rawVisualUserMedia", void 0), userMedia_define_property(this, "paused", false), userMedia_define_property(this, "recording", false), userMedia_define_property(this, "audioRecorder", void 0), userMedia_define_property(this, "currentVisualStream", void 0), userMedia_define_property(this, "onPlayReached", false), userMedia_define_property(this, "onLoadedMetaDataReached", false), userMedia_define_property(this, "playingPromiseReached", false);
+            super("UserMedia", options), userMedia_define_property(this, "recorder", void 0), userMedia_define_property(this, "rawVisualUserMedia", void 0), userMedia_define_property(this, "paused", false), userMedia_define_property(this, "recording", false), userMedia_define_property(this, "audioRecorder", void 0), userMedia_define_property(this, "currentVisualStream", void 0), userMedia_define_property(this, "onPlayReached", false), userMedia_define_property(this, "onLoadedMetaDataReached", false), userMedia_define_property(this, "playingPromiseReached", false), userMedia_define_property(this, "videoTrackLabel", void 0);
             this.recorder = recorder;
             this.rawVisualUserMedia = recorder.getRawVisualUserMedia();
             mediaEvents.forEach((eventName)=>{
@@ -17896,6 +17921,7 @@ var __webpack_exports__ = {};
                     framesCount: this.framesCount,
                     videoType
                 };
+                if (this.userMedia) this.recordingStats.videoTrackLabel = this.userMedia.getVideoTrackLabel();
                 if (isAudioEnabled(this.options) && this.userMedia) {
                     this.recordingStats.samplesCount = this.samplesCount;
                     this.recordingStats.sampleRate = this.userMedia.getAudioSampleRate();
@@ -19031,6 +19057,7 @@ var __webpack_exports__ = {};
                 else if (params.exc.message) this.options.logger.error(params.exc.message);
             } else this.options.logger.error(params.exc);
             if (this.options.displayErrors && params.err) this.visuals.error(params.err);
+            else if (this.options.displayErrors && params.exc && params.exc instanceof error_VideomailError) this.visuals.error(params.exc);
             else this.visuals.reset();
         }
         initEvents(playerOnly = false) {

package/dist/esm/index.js

@@ -3617,7 +3617,7 @@ const constants = {
     }
 };
 var package_namespaceObject = {
-    rE: "13.14.1"
+    rE: "13.15.1"
 };
 function isAudioEnabled(options) {
     return Boolean(options.audio.enabled);
@@ -6173,6 +6173,20 @@ const MEDIA_EVENTS = [
     "volumechange"
 ];
 const mediaEvents = MEDIA_EVENTS;
+const VIRTUAL_KEYWORDS = [
+    "obs",
+    "virtual",
+    "manycam",
+    "vcam",
+    "splitcam",
+    "droidcam"
+];
+function isVirtualCamera(videoTrack) {
+    const capabilities = videoTrack.getCapabilities();
+    if (!capabilities.frameRate) return true;
+    return VIRTUAL_KEYWORDS.some((keyword)=>videoTrack.label.toLowerCase().includes(keyword));
+}
+const util_isVirtualCamera = isVirtualCamera;
 function userMedia_define_property(obj, key, value) {
     if (key in obj) Object.defineProperty(obj, key, {
         value: value,
@@ -6237,6 +6251,7 @@ class UserMedia extends util_Despot {
         this.onPlayReached = false;
         this.onLoadedMetaDataReached = false;
         this.playingPromiseReached = false;
+        this.videoTrackLabel = void 0;
         if (isAudioEnabled(this.options)) this.audioRecorder ??= new media_AudioRecorder(this, this.options);
         const unloadAllEventListeners = ()=>{
             this.options.logger.debug("UserMedia: unloadAllEventListeners()");
@@ -6328,12 +6343,19 @@ class UserMedia extends util_Despot {
         };
         try {
             const videoTrack = media_getFirstVideoTrack(localMediaStream);
-            if (videoTrack) if (videoTrack.enabled) {
+            this.videoTrackLabel = videoTrack?.label;
+            if (videoTrack) if (videoTrack.enabled) if (util_isVirtualCamera(videoTrack)) throw error_createError({
+                message: "Virtual cameras are not allowed.",
+                explanation: `Please use a real camera, not "${videoTrack.label}".`,
+                options: this.options
+            });
+            else {
                 let description = "";
-                if (videoTrack.label && videoTrack.label.length > 0) description = description.concat(videoTrack.label);
+                if (videoTrack.label.length > 0) description = description.concat(videoTrack.label);
                 description = description.concat(` with enabled=${videoTrack.enabled}, muted=${videoTrack.muted}, readyState=${videoTrack.readyState}`);
                 this.options.logger.debug(`UserMedia: ${videoTrack.kind} detected. ${description}`);
-            } else throw error_createError({
+            }
+            else throw error_createError({
                 message: "Webcam is disabled",
                 explanation: "The video track seems to be disabled. Enable it in your system.",
                 options: this.options
@@ -6352,6 +6374,9 @@ class UserMedia extends util_Despot {
             });
         }
     }
+    getVideoTrackLabel() {
+        return this.videoTrackLabel;
+    }
     isReady() {
         return Boolean(this.rawVisualUserMedia?.src);
     }
@@ -6455,7 +6480,7 @@ class UserMedia extends util_Despot {
         };
     }
     constructor(recorder, options){
-        super("UserMedia", options), userMedia_define_property(this, "recorder", void 0), userMedia_define_property(this, "rawVisualUserMedia", void 0), userMedia_define_property(this, "paused", false), userMedia_define_property(this, "recording", false), userMedia_define_property(this, "audioRecorder", void 0), userMedia_define_property(this, "currentVisualStream", void 0), userMedia_define_property(this, "onPlayReached", false), userMedia_define_property(this, "onLoadedMetaDataReached", false), userMedia_define_property(this, "playingPromiseReached", false);
+        super("UserMedia", options), userMedia_define_property(this, "recorder", void 0), userMedia_define_property(this, "rawVisualUserMedia", void 0), userMedia_define_property(this, "paused", false), userMedia_define_property(this, "recording", false), userMedia_define_property(this, "audioRecorder", void 0), userMedia_define_property(this, "currentVisualStream", void 0), userMedia_define_property(this, "onPlayReached", false), userMedia_define_property(this, "onLoadedMetaDataReached", false), userMedia_define_property(this, "playingPromiseReached", false), userMedia_define_property(this, "videoTrackLabel", void 0);
         this.recorder = recorder;
         this.rawVisualUserMedia = recorder.getRawVisualUserMedia();
         mediaEvents.forEach((eventName)=>{
@@ -7020,6 +7045,7 @@ class Recorder extends util_Despot {
                 framesCount: this.framesCount,
                 videoType
             };
+            if (this.userMedia) this.recordingStats.videoTrackLabel = this.userMedia.getVideoTrackLabel();
             if (isAudioEnabled(this.options) && this.userMedia) {
                 this.recordingStats.samplesCount = this.samplesCount;
                 this.recordingStats.sampleRate = this.userMedia.getAudioSampleRate();
@@ -8093,6 +8119,7 @@ class Container extends util_Despot {
             else if (params.exc.message) this.options.logger.error(params.exc.message);
         } else this.options.logger.error(params.exc);
         if (this.options.displayErrors && params.err) this.visuals.error(params.err);
+        else if (this.options.displayErrors && params.exc && params.exc instanceof error_VideomailError) this.visuals.error(params.exc);
         else this.visuals.reset();
     }
     initEvents(playerOnly = false) {

package/dist/esm/types/RecordingStats.d.ts

@@ -9,5 +9,6 @@ interface RecordingStats {
     waitingTime?: number | undefined;
     wantedFps?: number;
     wantedInterval?: number;
+    videoTrackLabel?: string | undefined;
 }
 export type { RecordingStats };

package/dist/esm/util/isVirtualCamera.d.ts

@@ -0,0 +1,2 @@
+declare function isVirtualCamera(videoTrack: MediaStreamTrack): boolean;
+export default isVirtualCamera;

package/dist/esm/wrappers/form.d.ts

@@ -140,6 +140,7 @@ declare class Form extends Despot {
             waitingTime?: number | undefined | undefined;
             wantedFps?: number;
             wantedInterval?: number;
+            videoTrackLabel?: string | undefined | undefined;
         } | undefined;
         recordLocation?: string | undefined | undefined;
         parentKey?: string | undefined | undefined;
@@ -325,6 +326,7 @@ declare class Form extends Despot {
             waitingTime?: number | undefined | undefined;
             wantedFps?: number;
             wantedInterval?: number;
+            videoTrackLabel?: string | undefined | undefined;
         } | undefined;
         recordLocation?: string | undefined | undefined;
         parentKey?: string | undefined | undefined;

package/dist/esm/wrappers/visuals/userMedia.d.ts

@@ -17,6 +17,7 @@ declare class UserMedia extends Despot {
     private onPlayReached;
     private onLoadedMetaDataReached;
     private playingPromiseReached;
+    private videoTrackLabel?;
     constructor(recorder: Recorder, options: VideomailClientOptions);
     private attachMediaStream;
     private setVisualStream;
@@ -27,6 +28,7 @@ declare class UserMedia extends Despot {
     unloadRemainingEventListeners(): void;
     private audioRecord;
     init(localMediaStream: MediaStream, videoCallback: () => void, audioCallback: AudioProcessCB, endedEarlyCallback: (err: any) => void, switchingFacingMode?: ConstrainDOMString): void;
+    getVideoTrackLabel(): string | undefined;
     isReady(): boolean;
     stop(visualStream?: MediaStream, params?: StopParams): void;
     createCanvas(): HTMLCanvasElement;

package/dist/umd/index.js

@@ -10882,7 +10882,7 @@
             var client = __webpack_require__(5734);
             var client_default = /*#__PURE__*/ __webpack_require__.n(client);
             var package_namespaceObject = {
-                rE: "13.14.1"
+                rE: "13.15.1"
             };
             function isAudioEnabled(options) {
                 return Boolean(options.audio.enabled);
@@ -16779,6 +16779,20 @@
                 "volumechange"
             ];
             const mediaEvents = MEDIA_EVENTS;
+            const VIRTUAL_KEYWORDS = [
+                "obs",
+                "virtual",
+                "manycam",
+                "vcam",
+                "splitcam",
+                "droidcam"
+            ];
+            function isVirtualCamera(videoTrack) {
+                const capabilities = videoTrack.getCapabilities();
+                if (!capabilities.frameRate) return true;
+                return VIRTUAL_KEYWORDS.some((keyword)=>videoTrack.label.toLowerCase().includes(keyword));
+            }
+            const util_isVirtualCamera = isVirtualCamera;
             const EVENT_ASCII = "|—O—|";
             class UserMedia extends util_Despot {
                 recorder;
@@ -16790,6 +16804,7 @@
                 onPlayReached = false;
                 onLoadedMetaDataReached = false;
                 playingPromiseReached = false;
+                videoTrackLabel;
                 constructor(recorder, options){
                     super("UserMedia", options);
                     this.recorder = recorder;
@@ -16850,6 +16865,7 @@
                     this.onPlayReached = false;
                     this.onLoadedMetaDataReached = false;
                     this.playingPromiseReached = false;
+                    this.videoTrackLabel = void 0;
                     if (isAudioEnabled(this.options)) this.audioRecorder ??= new media_AudioRecorder(this, this.options);
                     const unloadAllEventListeners = ()=>{
                         this.options.logger.debug("UserMedia: unloadAllEventListeners()");
@@ -16941,12 +16957,19 @@
                     };
                     try {
                         const videoTrack = media_getFirstVideoTrack(localMediaStream);
-                        if (videoTrack) if (videoTrack.enabled) {
+                        this.videoTrackLabel = videoTrack?.label;
+                        if (videoTrack) if (videoTrack.enabled) if (util_isVirtualCamera(videoTrack)) throw error_createError({
+                            message: "Virtual cameras are not allowed.",
+                            explanation: `Please use a real camera, not "${videoTrack.label}".`,
+                            options: this.options
+                        });
+                        else {
                             let description = "";
-                            if (videoTrack.label && videoTrack.label.length > 0) description = description.concat(videoTrack.label);
+                            if (videoTrack.label.length > 0) description = description.concat(videoTrack.label);
                             description = description.concat(` with enabled=${videoTrack.enabled}, muted=${videoTrack.muted}, readyState=${videoTrack.readyState}`);
                             this.options.logger.debug(`UserMedia: ${videoTrack.kind} detected. ${description}`);
-                        } else throw error_createError({
+                        }
+                        else throw error_createError({
                             message: "Webcam is disabled",
                             explanation: "The video track seems to be disabled. Enable it in your system.",
                             options: this.options
@@ -16965,6 +16988,9 @@
                         });
                     }
                 }
+                getVideoTrackLabel() {
+                    return this.videoTrackLabel;
+                }
                 isReady() {
                     return Boolean(this.rawVisualUserMedia?.src);
                 }
@@ -17654,6 +17680,7 @@
                             framesCount: this.framesCount,
                             videoType
                         };
+                        if (this.userMedia) this.recordingStats.videoTrackLabel = this.userMedia.getVideoTrackLabel();
                         if (isAudioEnabled(this.options) && this.userMedia) {
                             this.recordingStats.samplesCount = this.samplesCount;
                             this.recordingStats.sampleRate = this.userMedia.getAudioSampleRate();
@@ -18719,6 +18746,7 @@
                         else if (params.exc.message) this.options.logger.error(params.exc.message);
                     } else this.options.logger.error(params.exc);
                     if (this.options.displayErrors && params.err) this.visuals.error(params.err);
+                    else if (this.options.displayErrors && params.exc && params.exc instanceof error_VideomailError) this.visuals.error(params.exc);
                     else this.visuals.reset();
                 }
                 initEvents(playerOnly = false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "videomail-client",
-  "version": "13.14.1",
+  "version": "13.15.1",
   "description": "A wicked npm package to record videos directly in the browser, for Deaf and Sign Language!",
   "keywords": [
     "webcam",
@@ -94,26 +94,26 @@
     "@types/ua-parser-js": "0.7.39",
     "@vitest/eslint-plugin": "1.6.20",
     "audit-ci": "7.1.0",
-    "chromatic": "17.5.0",
+    "chromatic": "17.7.2",
     "cross-env": "10.1.0",
-    "eslint": "10.5.0",
+    "eslint": "10.6.0",
     "eslint-import-resolver-typescript": "4.4.5",
     "eslint-plugin-de-morgan": "2.1.2",
     "eslint-plugin-depend": "1.5.0",
     "eslint-plugin-import-x": "4.17.0",
     "eslint-plugin-package-json": "1.5.0",
-    "eslint-plugin-regexp": "3.1.0",
+    "eslint-plugin-regexp": "3.1.1",
     "eslint-plugin-simple-import-sort": "13.0.0",
     "globals": "17.7.0",
     "jsdom": "29.1.1",
     "msw": "2.14.6",
     "msw-storybook-addon": "2.0.7",
-    "prettier": "3.8.4",
+    "prettier": "3.8.5",
     "prettier-plugin-curly": "0.4.1",
     "prettier-plugin-jsdoc": "1.8.1",
     "prettier-plugin-packagejson": "3.0.2",
     "prettier-plugin-sh": "0.18.1",
-    "release-it": "20.2.0",
+    "release-it": "20.2.1",
     "storybook": "10.4.6",
     "storybook-html-rsbuild": "3.3.4",
     "type-fest": "5.7.0",