@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 1.2.4 → 1.3.0

package/src/VideoPlayer/VideoPlayer.ts

@@ -1,6 +1,6 @@
 // Copyright Epic Games, Inc. All Rights Reserved.
 
-import { Config, Flags } from '../Config/Config';
+import { Config, Flags, NumericParameters } from '../Config/Config';
 import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
 
 /**
@@ -16,6 +16,9 @@ declare global {
  * The video player html element
  */
 export class VideoPlayer {
+    // Common H.264 maximum encoding dimension. Streams beyond this commonly fail to encode.
+    private static readonly maxEncoderDimension = 4096;
+
     private config: Config;
     private videoElement: HTMLVideoElement;
     private audioElement?: HTMLAudioElement;
@@ -43,21 +46,21 @@ export class VideoPlayer {
         videoElementParent.appendChild(this.videoElement);
 
         this.onResizePlayerCallback = () => {
-            console.log('Resolution changed, restyling player, did you forget to override this function?');
+            Logger.Warning('Resolution changed, restyling player, did you forget to override this function?');
         };
         this.onMatchViewportResolutionCallback = () => {
-            console.log(
+            Logger.Warning(
                 'Resolution changed and match viewport resolution is turned on, did you forget to override this function?'
             );
         };
 
         // set play for video (and audio)
         this.videoElement.onclick = () => {
-            if (this.audioElement != undefined && this.audioElement.paused) {
-                this.audioElement.play();
+            if (this.audioElement !== undefined && this.audioElement.paused) {
+                void this.audioElement.play();
             }
             if (this.videoElement.paused) {
-                this.videoElement.play();
+                void this.videoElement.play();
             }
         };
 
@@ -222,10 +225,23 @@ export class VideoPlayer {
                 return;
             }
 
-            this.onMatchViewportResolutionCallback(
-                videoElementParent.clientWidth,
-                videoElementParent.clientHeight
-            );
+            const viewportResolutionScale = this.config.hasNumericSetting(NumericParameters.ViewportResScale)
+                ? this.config.getNumericSettingValue(NumericParameters.ViewportResScale)
+                : 1.0;
+
+            const scaledWidth = Math.round(videoElementParent.clientWidth * viewportResolutionScale);
+            const scaledHeight = Math.round(videoElementParent.clientHeight * viewportResolutionScale);
+
+            if (
+                scaledWidth > VideoPlayer.maxEncoderDimension ||
+                scaledHeight > VideoPlayer.maxEncoderDimension
+            ) {
+                Logger.Warning(
+                    `Requested stream resolution (${scaledWidth}x${scaledHeight}) exceeds the common H.264 encoder limit of ${VideoPlayer.maxEncoderDimension}x${VideoPlayer.maxEncoderDimension}; encoding may fail. Lower ViewportResScale or disable MatchViewportResolution.`
+                );
+            }
+
+            this.onMatchViewportResolutionCallback(scaledWidth, scaledHeight);
 
             this.lastTimeResized = new Date().getTime();
         } else {

package/src/WebRtcPlayer/WebRtcPlayerController.ts

@@ -244,7 +244,7 @@ export class WebRtcPlayerController {
             this.afkController.stopAfkWarningTimer();
 
             // stop sending stats on interval if we have closed our connection
-            if (this.statsTimerHandle && this.statsTimerHandle !== undefined) {
+            if (this.statsTimerHandle) {
                 window.clearInterval(this.statsTimerHandle);
             }
 
@@ -1952,7 +1952,7 @@ export class WebRtcPlayerController {
             const mouseMode = this.config.isFlagEnabled(Flags.HoveringMouseMode)
                 ? ControlSchemeType.HoveringMouse
                 : ControlSchemeType.LockedMouse;
-            this.mouseController = this.inputClassesFactory.registerMouse(mouseMode);
+            this.mouseController = this.inputClassesFactory.registerMouse(mouseMode, this.config);
         }
     }
 

package/src/WebXR/WebXRController.ts

@@ -56,14 +56,14 @@ export class WebXRController {
                 return;
             }
 
-            navigator.xr
+            void navigator.xr
                 /* Request immersive-vr session without any optional features. */
                 .requestSession('immersive-vr', { optionalFeatures: [] })
                 .then((session: XRSession) => {
                     this.onXrSessionStarted(session);
                 });
         } else {
-            this.xrSession.end();
+            void this.xrSession.end();
         }
     }
 
@@ -265,11 +265,11 @@ export class WebXRController {
         this.initShaders();
         this.initBuffers();
 
-        session.requestReferenceSpace('local').then((refSpace) => {
+        void session.requestReferenceSpace('local').then((refSpace) => {
             this.xrRefSpace = refSpace;
 
             // Set up our base layer (i.e. a projection layer that fills the entire XR viewport).
-            this.xrSession.updateRenderState({
+            void this.xrSession.updateRenderState({
                 baseLayer: new XRWebGLLayer(this.xrSession, this.gl)
             });
 
@@ -277,7 +277,7 @@ export class WebXRController {
             if (this.xrSession.supportedFrameRates) {
                 for (const frameRate of this.xrSession.supportedFrameRates) {
                     if (frameRate == 90) {
-                        session.updateTargetFrameRate(90);
+                        void session.updateTargetFrameRate(90);
                     }
                 }
             }
@@ -485,12 +485,16 @@ export class WebXRController {
             Logger.Info('WebXR requires https, if you want WebXR use https.');
         }
 
-        if (navigator.xr) {
-            return navigator.xr.isSessionSupported(mode);
-        } else {
-            return new Promise<boolean>(() => {
-                return false;
-            });
+        // Wrap in try-catch because access to XR object can be denied due
+        // to browser security permissions (e.g. streaming from an iframe)
+        try {
+            if (navigator.xr) {
+                return navigator.xr.isSessionSupported(mode);
+            }
+        } catch {
+            return Promise.resolve(false);
         }
+
+        return Promise.resolve(false);
     }
 }