@arcware-cloud/pixelstreaming-websdk 1.3.8 → 1.3.9

package/README.md

@@ -80,6 +80,10 @@ For more detailed examples and advanced usage, please refer to our documentation
 
 # Changelog
 
+### 1.3.9
+
+- added an event handler to check if video is streaming if cloud requests evidence
+
 ### 1.3.8
 
 - fixed error handling in SDK to back of reconnects if connection was intentionally terminated by cloud

package/index.cjs.js

@@ -23420,7 +23420,7 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
         if (!config.initialSettings.ss)
             config.initialSettings.ss = exports.DefaultUrl;
         super(config);
-        this.VERSION = "1.3.8";
+        this.VERSION = "1.3.9";
         this.settings = settings;
         this.session = new Session_1.Session();
         this._initialSettings = config.initialSettings;
@@ -23725,6 +23725,7 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
         this.addMessageHandler("ping", shared_pixelstreaming_websdk_1.Messages.ZPing, this.onPing);
         this.addMessageHandler("queue", shared_pixelstreaming_websdk_1.Messages.ZQueue, this.onQueue);
         this.addMessageHandler("version", shared_pixelstreaming_websdk_1.Messages.ZVersion, this.onVersion);
+        this.addMessageHandler("render", shared_pixelstreaming_websdk_1.Messages.ZRender, this.onRender);
         // Create a debounced version of the handleResolutionChange function
         const debouncedResolutionChange = (0, debounce_1.default)(() => {
             this.handleResolutionChange();
@@ -23791,6 +23792,64 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
             }
         });
     }
+    isVideoRenderingNow(video) {
+        if (!video)
+            return false;
+        const hasDims = video.videoWidth > 0 && video.videoHeight > 0;
+        const hasData = video.readyState >= HTMLMediaElement.HAVE_CURRENT_DATA; // ≥2
+        const playing = !video.paused && !video.ended;
+        // Be conservative: require at least two signals to avoid metadata-only false positives
+        return (hasDims && hasData) || (hasDims && playing) || (hasData && playing);
+    }
+    waitForFirstFrameWithTimeout(ms = 2000) {
+        var _a, _b, _c;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const video = (_c = (_b = (_a = this.webRtcController) === null || _a === void 0 ? void 0 : _a.videoPlayer) === null || _b === void 0 ? void 0 : _b.getVideoElement) === null || _c === void 0 ? void 0 : _c.call(_b);
+            if (this.isVideoRenderingNow(video))
+                return true;
+            let t;
+            const ok = yield Promise.race([
+                new Promise((resolve) => {
+                    var _a, _b;
+                    const done = () => {
+                        cleanup();
+                        resolve(true);
+                    };
+                    const cleanup = () => {
+                        var _a, _b;
+                        video.removeEventListener("playing", onPlaying);
+                        video.removeEventListener("resize", onResize);
+                        if ("cancelVideoFrameCallback" in HTMLVideoElement.prototype && rvfcId != null) {
+                            (_b = (_a = video).cancelVideoFrameCallback) === null || _b === void 0 ? void 0 : _b.call(_a, rvfcId);
+                        }
+                    };
+                    const onPlaying = () => this.isVideoRenderingNow(video) && done();
+                    const onResize = () => this.isVideoRenderingNow(video) && done();
+                    video.addEventListener("playing", onPlaying, { once: true });
+                    video.addEventListener("resize", onResize, { once: true });
+                    const rvfcId = "requestVideoFrameCallback" in HTMLVideoElement.prototype
+                        ? (_b = (_a = video).requestVideoFrameCallback) === null || _b === void 0 ? void 0 : _b.call(_a, () => done())
+                        : null;
+                }),
+                new Promise((resolve) => {
+                    t = window.setTimeout(() => resolve(false), ms);
+                })
+            ]);
+            if (t)
+                clearTimeout(t);
+            return ok;
+        });
+    }
+    onRender(_msg) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const isRendering = yield this.waitForFirstFrameWithTimeout();
+            const payload = {
+                type: "render",
+                isRendering: isRendering
+            };
+            this.send(payload); // uses buffered send
+        });
+    }
     /** On ping the session creation timestamp will be updated. */
     onPing(message) {
         var _a, _b;
@@ -26427,6 +26486,20 @@ exports.ZQueue = zod_1.z.object({
 });
 
 
+/***/ }),
+
+/***/ 1919:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.ZRender = void 0;
+const zod_1 = __webpack_require__(8754);
+exports.ZRender = zod_1.z.object({
+    type: zod_1.z.literal("render")
+});
+
+
 /***/ }),
 
 /***/ 4201:
@@ -26784,9 +26857,10 @@ tslib_1.__exportStar(__webpack_require__(1224), exports);
 tslib_1.__exportStar(__webpack_require__(4882), exports);
 tslib_1.__exportStar(__webpack_require__(3751), exports);
 tslib_1.__exportStar(__webpack_require__(9864), exports);
+tslib_1.__exportStar(__webpack_require__(1919), exports);
 const Stats_1 = __webpack_require__(3403);
 exports.Send = {
-    stats: Stats_1.ZStats,
+    stats: Stats_1.ZStats
 };
 
 

package/index.esm.js

@@ -23428,7 +23428,7 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
         if (!config.initialSettings.ss)
             config.initialSettings.ss = DefaultUrl;
         super(config);
-        this.VERSION = "1.3.8";
+        this.VERSION = "1.3.9";
         this.settings = settings;
         this.session = new _domain_Session__WEBPACK_IMPORTED_MODULE_0__.Session();
         this._initialSettings = config.initialSettings;
@@ -23750,6 +23750,7 @@ class ArcwarePixelStreaming extends _epicgames_ps_lib_pixelstreamingfrontend_ue5
         this.addMessageHandler("ping", _arcware_cloud_shared_pixelstreaming_websdk__WEBPACK_IMPORTED_MODULE_0__.Messages.ZPing, this.onPing);
         this.addMessageHandler("queue", _arcware_cloud_shared_pixelstreaming_websdk__WEBPACK_IMPORTED_MODULE_0__.Messages.ZQueue, this.onQueue);
         this.addMessageHandler("version", _arcware_cloud_shared_pixelstreaming_websdk__WEBPACK_IMPORTED_MODULE_0__.Messages.ZVersion, this.onVersion);
+        this.addMessageHandler("render", _arcware_cloud_shared_pixelstreaming_websdk__WEBPACK_IMPORTED_MODULE_0__.Messages.ZRender, this.onRender);
         // Create a debounced version of the handleResolutionChange function
         const debouncedResolutionChange = (0,_domain_debounce__WEBPACK_IMPORTED_MODULE_8__["default"])(() => {
             this.handleResolutionChange();
@@ -23816,6 +23817,64 @@ class ArcwarePixelStreaming extends _epicgames_ps_lib_pixelstreamingfrontend_ue5
             }
         });
     }
+    isVideoRenderingNow(video) {
+        if (!video)
+            return false;
+        const hasDims = video.videoWidth > 0 && video.videoHeight > 0;
+        const hasData = video.readyState >= HTMLMediaElement.HAVE_CURRENT_DATA; // ≥2
+        const playing = !video.paused && !video.ended;
+        // Be conservative: require at least two signals to avoid metadata-only false positives
+        return (hasDims && hasData) || (hasDims && playing) || (hasData && playing);
+    }
+    waitForFirstFrameWithTimeout(ms = 2000) {
+        var _a, _b, _c;
+        return (0,tslib__WEBPACK_IMPORTED_MODULE_9__.__awaiter)(this, void 0, void 0, function* () {
+            const video = (_c = (_b = (_a = this.webRtcController) === null || _a === void 0 ? void 0 : _a.videoPlayer) === null || _b === void 0 ? void 0 : _b.getVideoElement) === null || _c === void 0 ? void 0 : _c.call(_b);
+            if (this.isVideoRenderingNow(video))
+                return true;
+            let t;
+            const ok = yield Promise.race([
+                new Promise((resolve) => {
+                    var _a, _b;
+                    const done = () => {
+                        cleanup();
+                        resolve(true);
+                    };
+                    const cleanup = () => {
+                        var _a, _b;
+                        video.removeEventListener("playing", onPlaying);
+                        video.removeEventListener("resize", onResize);
+                        if ("cancelVideoFrameCallback" in HTMLVideoElement.prototype && rvfcId != null) {
+                            (_b = (_a = video).cancelVideoFrameCallback) === null || _b === void 0 ? void 0 : _b.call(_a, rvfcId);
+                        }
+                    };
+                    const onPlaying = () => this.isVideoRenderingNow(video) && done();
+                    const onResize = () => this.isVideoRenderingNow(video) && done();
+                    video.addEventListener("playing", onPlaying, { once: true });
+                    video.addEventListener("resize", onResize, { once: true });
+                    const rvfcId = "requestVideoFrameCallback" in HTMLVideoElement.prototype
+                        ? (_b = (_a = video).requestVideoFrameCallback) === null || _b === void 0 ? void 0 : _b.call(_a, () => done())
+                        : null;
+                }),
+                new Promise((resolve) => {
+                    t = window.setTimeout(() => resolve(false), ms);
+                })
+            ]);
+            if (t)
+                clearTimeout(t);
+            return ok;
+        });
+    }
+    onRender(_msg) {
+        return (0,tslib__WEBPACK_IMPORTED_MODULE_9__.__awaiter)(this, void 0, void 0, function* () {
+            const isRendering = yield this.waitForFirstFrameWithTimeout();
+            const payload = {
+                type: "render",
+                isRendering: isRendering
+            };
+            this.send(payload); // uses buffered send
+        });
+    }
     /** On ping the session creation timestamp will be updated. */
     onPing(message) {
         var _a, _b;
@@ -26492,6 +26551,22 @@ const ZQueue = zod__WEBPACK_IMPORTED_MODULE_0__.z.object({
 });
 
 
+/***/ }),
+
+/***/ 1919:
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "ZRender": () => (/* binding */ ZRender)
+/* harmony export */ });
+/* harmony import */ var zod__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(1604);
+
+const ZRender = zod__WEBPACK_IMPORTED_MODULE_0__.z.object({
+    type: zod__WEBPACK_IMPORTED_MODULE_0__.z.literal("render")
+});
+
+
 /***/ }),
 
 /***/ 4201:
@@ -26829,6 +26904,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   "ZLoveLetter": () => (/* reexport safe */ _LoveLetter__WEBPACK_IMPORTED_MODULE_1__.ZLoveLetter),
 /* harmony export */   "ZPing": () => (/* reexport safe */ _Ping__WEBPACK_IMPORTED_MODULE_5__.ZPing),
 /* harmony export */   "ZQueue": () => (/* reexport safe */ _Queue__WEBPACK_IMPORTED_MODULE_6__.ZQueue),
+/* harmony export */   "ZRender": () => (/* reexport safe */ _Render__WEBPACK_IMPORTED_MODULE_9__.ZRender),
 /* harmony export */   "ZSessionId": () => (/* reexport safe */ _SessionId__WEBPACK_IMPORTED_MODULE_2__.ZSessionId),
 /* harmony export */   "ZStats": () => (/* reexport safe */ _Stats__WEBPACK_IMPORTED_MODULE_4__.ZStats),
 /* harmony export */   "ZStreamInfo": () => (/* reexport safe */ _StreamInfo__WEBPACK_IMPORTED_MODULE_3__.ZStreamInfo),
@@ -26843,6 +26919,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _Queue__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(4882);
 /* harmony import */ var _Version__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(3751);
 /* harmony import */ var _WebSdkSettings__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(9864);
+/* harmony import */ var _Render__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(1919);
+
 
 
 
@@ -26854,7 +26932,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 const Send = {
-    stats: _Stats__WEBPACK_IMPORTED_MODULE_4__.ZStats,
+    stats: _Stats__WEBPACK_IMPORTED_MODULE_4__.ZStats
 };
 
 

package/index.umd.js

@@ -23430,7 +23430,7 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
         if (!config.initialSettings.ss)
             config.initialSettings.ss = exports.DefaultUrl;
         super(config);
-        this.VERSION = "1.3.8";
+        this.VERSION = "1.3.9";
         this.settings = settings;
         this.session = new Session_1.Session();
         this._initialSettings = config.initialSettings;
@@ -23735,6 +23735,7 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
         this.addMessageHandler("ping", shared_pixelstreaming_websdk_1.Messages.ZPing, this.onPing);
         this.addMessageHandler("queue", shared_pixelstreaming_websdk_1.Messages.ZQueue, this.onQueue);
         this.addMessageHandler("version", shared_pixelstreaming_websdk_1.Messages.ZVersion, this.onVersion);
+        this.addMessageHandler("render", shared_pixelstreaming_websdk_1.Messages.ZRender, this.onRender);
         // Create a debounced version of the handleResolutionChange function
         const debouncedResolutionChange = (0, debounce_1.default)(() => {
             this.handleResolutionChange();
@@ -23801,6 +23802,64 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
             }
         });
     }
+    isVideoRenderingNow(video) {
+        if (!video)
+            return false;
+        const hasDims = video.videoWidth > 0 && video.videoHeight > 0;
+        const hasData = video.readyState >= HTMLMediaElement.HAVE_CURRENT_DATA; // ≥2
+        const playing = !video.paused && !video.ended;
+        // Be conservative: require at least two signals to avoid metadata-only false positives
+        return (hasDims && hasData) || (hasDims && playing) || (hasData && playing);
+    }
+    waitForFirstFrameWithTimeout(ms = 2000) {
+        var _a, _b, _c;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const video = (_c = (_b = (_a = this.webRtcController) === null || _a === void 0 ? void 0 : _a.videoPlayer) === null || _b === void 0 ? void 0 : _b.getVideoElement) === null || _c === void 0 ? void 0 : _c.call(_b);
+            if (this.isVideoRenderingNow(video))
+                return true;
+            let t;
+            const ok = yield Promise.race([
+                new Promise((resolve) => {
+                    var _a, _b;
+                    const done = () => {
+                        cleanup();
+                        resolve(true);
+                    };
+                    const cleanup = () => {
+                        var _a, _b;
+                        video.removeEventListener("playing", onPlaying);
+                        video.removeEventListener("resize", onResize);
+                        if ("cancelVideoFrameCallback" in HTMLVideoElement.prototype && rvfcId != null) {
+                            (_b = (_a = video).cancelVideoFrameCallback) === null || _b === void 0 ? void 0 : _b.call(_a, rvfcId);
+                        }
+                    };
+                    const onPlaying = () => this.isVideoRenderingNow(video) && done();
+                    const onResize = () => this.isVideoRenderingNow(video) && done();
+                    video.addEventListener("playing", onPlaying, { once: true });
+                    video.addEventListener("resize", onResize, { once: true });
+                    const rvfcId = "requestVideoFrameCallback" in HTMLVideoElement.prototype
+                        ? (_b = (_a = video).requestVideoFrameCallback) === null || _b === void 0 ? void 0 : _b.call(_a, () => done())
+                        : null;
+                }),
+                new Promise((resolve) => {
+                    t = window.setTimeout(() => resolve(false), ms);
+                })
+            ]);
+            if (t)
+                clearTimeout(t);
+            return ok;
+        });
+    }
+    onRender(_msg) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const isRendering = yield this.waitForFirstFrameWithTimeout();
+            const payload = {
+                type: "render",
+                isRendering: isRendering
+            };
+            this.send(payload); // uses buffered send
+        });
+    }
     /** On ping the session creation timestamp will be updated. */
     onPing(message) {
         var _a, _b;
@@ -26437,6 +26496,20 @@ exports.ZQueue = zod_1.z.object({
 });
 
 
+/***/ }),
+
+/***/ 1919:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.ZRender = void 0;
+const zod_1 = __webpack_require__(8754);
+exports.ZRender = zod_1.z.object({
+    type: zod_1.z.literal("render")
+});
+
+
 /***/ }),
 
 /***/ 4201:
@@ -26794,9 +26867,10 @@ tslib_1.__exportStar(__webpack_require__(1224), exports);
 tslib_1.__exportStar(__webpack_require__(4882), exports);
 tslib_1.__exportStar(__webpack_require__(3751), exports);
 tslib_1.__exportStar(__webpack_require__(9864), exports);
+tslib_1.__exportStar(__webpack_require__(1919), exports);
 const Stats_1 = __webpack_require__(3403);
 exports.Send = {
-    stats: Stats_1.ZStats,
+    stats: Stats_1.ZStats
 };
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcware-cloud/pixelstreaming-websdk",
   "description": "WebSDK for easy implementation of pixel streaming with Arcware Cloud Services. Heavily based on the '@epicgames-ps' library.",
-  "version": "1.3.8",
+  "version": "1.3.9",
   "type": "commonjs",
   "main": "./index.umd.js",
   "module": "./index.umd.js",

package/types/lib/ArcwareConfig.d.ts

@@ -26,7 +26,7 @@ export declare class ArcwareConfig extends Config {
     readonly session: Session;
     readonly settings: Settings;
     private _initialSettings;
-    readonly VERSION = "1.3.8";
+    readonly VERSION = "1.3.9";
     constructor(config: ArcwareConfigParams);
     /** Setup connection string. */
     get urlFlags(): string;

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -50,6 +50,9 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
      */
     /** On version requested, the version of the WebSDK would be returned. */
     private onVersion;
+    private isVideoRenderingNow;
+    private waitForFirstFrameWithTimeout;
+    private onRender;
     /** On ping the session creation timestamp will be updated. */
     private onPing;
     /** Handle incoming configurations. */

package/types/shared/lib/Messages/Render.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const ZRender: z.ZodObject<{
+    type: z.ZodLiteral<"render">;
+}, "strip", z.ZodTypeAny, {
+    type?: "render";
+}, {
+    type?: "render";
+}>;
+export type Render = z.infer<typeof ZRender>;

package/types/shared/lib/Messages/index.d.ts

@@ -7,6 +7,7 @@ export * from "./Ping";
 export * from "./Queue";
 export * from "./Version";
 export * from "./WebSdkSettings";
+export * from "./Render";
 export declare const Send: {
     stats: import("zod").ZodObject<{
         type: import("zod").ZodLiteral<"stats">;