@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.1.4 → 0.3.0

package/{types → dist/types}/WebXR/WebXRController.d.ts

@@ -1,42 +1,42 @@
-/// <reference types="webxr" />
-import { WebRtcPlayerController } from '../WebRtcPlayer/WebRtcPlayerController';
-export declare class WebXRController {
-    private xrSession;
-    private xrRefSpace;
-    private gl;
-    private xrViewerPose;
-    private EPSILON;
-    private positionLocation;
-    private texcoordLocation;
-    private positionBuffer;
-    private texcoordBuffer;
-    private videoTexture;
-    private prevVideoWidth;
-    private prevVideoHeight;
-    private webRtcController;
-    private xrGamepadController;
-    private leftView;
-    private rightView;
-    private lastSentLeftEyeProj;
-    private lastSentRightEyeProj;
-    private lastSentRelativeLeftEyePos;
-    private lastSentRelativeRightEyePos;
-    onSessionStarted: EventTarget;
-    onSessionEnded: EventTarget;
-    onFrame: EventTarget;
-    constructor(webRtcPlayerController: WebRtcPlayerController);
-    xrClicked(): void;
-    onXrSessionEnded(): void;
-    initGL(): void;
-    initShaders(): void;
-    updateVideoTexture(): void;
-    initBuffers(): void;
-    onXrSessionStarted(session: XRSession): void;
-    areArraysEqual(a: Float32Array, b: Float32Array): boolean;
-    arePointsEqual(a: DOMPointReadOnly, b: DOMPointReadOnly): boolean;
-    sendXRDataToUE(): void;
-    onXrFrame(time: DOMHighResTimeStamp, frame: XRFrame): void;
-    private updateViews;
-    private render;
-    static isSessionSupported(mode: XRSessionMode): Promise<boolean>;
-}
+/// <reference types="webxr" />
+import { WebRtcPlayerController } from '../WebRtcPlayer/WebRtcPlayerController';
+export declare class WebXRController {
+    private xrSession;
+    private xrRefSpace;
+    private gl;
+    private xrViewerPose;
+    private EPSILON;
+    private positionLocation;
+    private texcoordLocation;
+    private positionBuffer;
+    private texcoordBuffer;
+    private videoTexture;
+    private prevVideoWidth;
+    private prevVideoHeight;
+    private webRtcController;
+    private xrGamepadController;
+    private leftView;
+    private rightView;
+    private lastSentLeftEyeProj;
+    private lastSentRightEyeProj;
+    private lastSentRelativeLeftEyePos;
+    private lastSentRelativeRightEyePos;
+    onSessionStarted: EventTarget;
+    onSessionEnded: EventTarget;
+    onFrame: EventTarget;
+    constructor(webRtcPlayerController: WebRtcPlayerController);
+    xrClicked(): void;
+    onXrSessionEnded(): void;
+    initGL(): void;
+    initShaders(): void;
+    updateVideoTexture(): void;
+    initBuffers(): void;
+    onXrSessionStarted(session: XRSession): void;
+    areArraysEqual(a: Float32Array, b: Float32Array): boolean;
+    arePointsEqual(a: DOMPointReadOnly, b: DOMPointReadOnly): boolean;
+    sendXRDataToUE(): void;
+    onXrFrame(time: DOMHighResTimeStamp, frame: XRFrame): void;
+    private updateViews;
+    private render;
+    static isSessionSupported(mode: XRSessionMode): Promise<boolean>;
+}

package/{types → dist/types}/pixelstreamingfrontend.d.ts

@@ -1,22 +1,23 @@
-export { WebRtcPlayerController } from './WebRtcPlayer/WebRtcPlayerController';
-export { WebXRController } from './WebXR/WebXRController';
-export { Config, ControlSchemeType, Flags, NumericParameters, TextParameters, OptionParameters, FlagsIds, NumericParametersIds, TextParametersIds, OptionParametersIds, AllSettings } from './Config/Config';
-export { SettingBase } from './Config/SettingBase';
-export { SettingFlag } from './Config/SettingFlag';
-export { SettingNumber } from './Config/SettingNumber';
-export { SettingOption } from './Config/SettingOption';
-export { SettingText } from './Config/SettingText';
-export { PixelStreaming } from './PixelStreaming/PixelStreaming';
-export { AFKController as AfkLogic } from './AFK/AFKController';
-export { LatencyTestResults } from './DataChannel/LatencyTestResults';
-export { EncoderSettings, InitialSettings, WebRTCSettings } from './DataChannel/InitialSettings';
-export { AggregatedStats } from './PeerConnectionController/AggregatedStats';
-export { UnquantizedDenormalizedUnsignedCoord as UnquantizedAndDenormalizeUnsigned } from './Util/CoordinateConverter';
-export { MessageDirection } from './UeInstanceMessage/StreamMessageController';
-export { CandidatePairStats } from './PeerConnectionController/CandidatePairStats';
-export { CandidateStat } from './PeerConnectionController/CandidateStat';
-export { DataChannelStats } from './PeerConnectionController/DataChannelStats';
-export { InboundAudioStats, InboundVideoStats } from './PeerConnectionController/InboundRTPStats';
-export { OutBoundVideoStats } from './PeerConnectionController/OutBoundRTPStats';
-export * from './Util/EventEmitter';
-export * from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
+export { WebRtcPlayerController } from './WebRtcPlayer/WebRtcPlayerController';
+export { WebXRController } from './WebXR/WebXRController';
+export { Config, ControlSchemeType, Flags, NumericParameters, TextParameters, OptionParameters, FlagsIds, NumericParametersIds, TextParametersIds, OptionParametersIds, AllSettings } from './Config/Config';
+export { SettingBase } from './Config/SettingBase';
+export { SettingFlag } from './Config/SettingFlag';
+export { SettingNumber } from './Config/SettingNumber';
+export { SettingOption } from './Config/SettingOption';
+export { SettingText } from './Config/SettingText';
+export { PixelStreaming } from './PixelStreaming/PixelStreaming';
+export { AFKController as AfkLogic } from './AFK/AFKController';
+export { LatencyTestResults } from './DataChannel/LatencyTestResults';
+export { EncoderSettings, InitialSettings, WebRTCSettings, PixelStreamingSettings } from './DataChannel/InitialSettings';
+export { AggregatedStats } from './PeerConnectionController/AggregatedStats';
+export { InputCoordTranslator, UntranslatedCoordUnsigned as UnquantizedAndDenormalizeUnsigned } from './Util/InputCoordTranslator';
+export { MessageDirection } from './UeInstanceMessage/StreamMessageController';
+export { CandidatePairStats } from './PeerConnectionController/CandidatePairStats';
+export { CandidateStat } from './PeerConnectionController/CandidateStat';
+export { DataChannelStats } from './PeerConnectionController/DataChannelStats';
+export { InboundAudioStats, InboundVideoStats } from './PeerConnectionController/InboundRTPStats';
+export { OutBoundVideoStats } from './PeerConnectionController/OutBoundRTPStats';
+export * from './DataChannel/DataChannelLatencyTestResults';
+export * from './Util/EventEmitter';
+export * from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';

package/package.json

@@ -1,39 +1,37 @@
 {
     "name": "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5",
-    "version": "0.1.4",
+    "version": "0.3.0",
     "description": "Frontend library for Unreal Engine 5.5 Pixel Streaming",
-    "main": "dist/lib-pixelstreamingfrontend.js",
-    "module": "dist/lib-pixelstreamingfrontend.esm.js",
-    "types": "types/pixelstreamingfrontend.d.ts",
+    "main": "dist/commonjs/pixelstreamingfrontend.js",
+    "module": "dist/esm/pixelstreamingfrontend.js",
+    "types": "dist/types/pixelstreamingfrontend.d.ts",
     "sideEffects": false,
     "scripts": {
-        "compile": "tsc --build --clean && tsc",
-        "build": "webpack --config webpack.prod.js",
-        "build-all": "cd ../../Common && npm install && npm run build && cd ../Frontend/library && npm link ../../Common && webpack --config webpack.prod.js",
-        "build-dev": "cd ../../Common && npm install && npm run build && cd ../Frontend/library && npm link ../../Common && webpack --config webpack.dev.js",
+        "compile": "tsc --project tsconfig.esm.json && tsc --project tsconfig.cjs.json",
+        "build": "npm run compile",
+        "build-all": "cd ../../Common && npm install && npm run build && cd ../Frontend/library && npm install && npm run build",
         "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
         "test": "jest --detectOpenHandles --coverage=true",
         "spellcheck": "cspell \"{README.md,.github/*.md,src/**/*.ts}\""
     },
     "devDependencies": {
         "@types/jest": "27.5.1",
-        "@types/webxr": "^0.5.1",
         "@typescript-eslint/eslint-plugin": "^6.21.0",
         "cspell": "^4.1.0",
         "eslint": "^8.11.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.2.1",
         "jest": "^27.5.1",
         "jest-environment-jsdom": "27.5.1",
-        "prettier": "2.8.3",
+        "prettier": "3.3.3",
         "ts-jest": "27.1.5",
-        "ts-loader": "^9.4.2",
         "typedoc": "^0.23.24",
-        "typescript": "^4.9.4",
-        "webpack": "^5.75.0",
-        "webpack-cli": "^5.0.1"
+        "typescript": "^4.9.4"
     },
     "dependencies": {
-        "sdp": "^3.1.0",
-        "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "^0.0.14"
+        "@types/webxr": "^0.5.1",
+        "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "^0.1.0",
+        "sdp": "^3.1.0"
     },
     "repository": {
         "type": "git",
@@ -45,4 +43,3 @@
         "access": "public"
     }
 }
-

package/readme.md

@@ -11,5 +11,13 @@ See [lib-pixelstreamingfrontend-ui](/Frontend/implementations/typescript) for an
 - Opens a data channel connection sending and receiving custom data (in addition to input).
 
 ### Adding it to your project
-`npm i @epicgames-ps/lib-pixelstreamingfrontend-ue5.4`
+`npm i @epicgames-ps/lib-pixelstreamingfrontend-ue5.5`
 
+### How this library is built
+The NPM packages supports:
+- ES6 module usage
+- CommonJS usage
+- Type definitions
+- Source maps
+
+**Note:** The NPM package does not contain a minified/bundled output, this is up to the user to do this in their application.

package/src/AFK/AFKController.ts

@@ -12,7 +12,6 @@ import {
 
 export class AFKController {
     // time out logic details
-    closeTimeout = 10;
     active = false;
     countdownActive = false;
     warnTimer: ReturnType<typeof setTimeout> = undefined;
@@ -24,18 +23,12 @@ export class AFKController {
 
     onAFKTimedOutCallback: () => void;
 
-    constructor(
-        config: Config,
-        pixelStreaming: PixelStreaming,
-        onDismissAfk: () => void
-    ) {
+    constructor(config: Config, pixelStreaming: PixelStreaming, onDismissAfk: () => void) {
         this.config = config;
         this.pixelStreaming = pixelStreaming;
         this.onDismissAfk = onDismissAfk;
         this.onAFKTimedOutCallback = () => {
-            console.log(
-                'AFK timed out, did you want to override this callback?'
-            );
+            console.log('AFK timed out, did you want to override this callback?');
         };
     }
 
@@ -47,9 +40,7 @@ export class AFKController {
 
         if (this.active || this.countdownActive) {
             this.startAfkWarningTimer();
-            this.pixelStreaming.dispatchEvent(
-                new AfkWarningDeactivateEvent()
-            );
+            this.pixelStreaming.dispatchEvent(new AfkWarningDeactivateEvent());
         }
     }
 
@@ -58,9 +49,7 @@ export class AFKController {
      */
     startAfkWarningTimer() {
         if (
-            this.config.getNumericSettingValue(
-                NumericParameters.AFKTimeoutSecs
-            ) > 0 &&
+            this.config.getNumericSettingValue(NumericParameters.AFKTimeoutSecs) > 0 &&
             this.config.isFlagEnabled(Flags.AFKDetection)
         ) {
             this.active = true;
@@ -95,9 +84,7 @@ export class AFKController {
             clearTimeout(this.warnTimer);
             this.warnTimer = setTimeout(
                 () => this.activateAfkEvent(),
-                this.config.getNumericSettingValue(
-                    NumericParameters.AFKTimeoutSecs
-                ) * 1000
+                this.config.getNumericSettingValue(NumericParameters.AFKTimeoutSecs) * 1000
             );
         }
     }
@@ -118,11 +105,9 @@ export class AFKController {
         );
 
         // update our countDown timer and overlay contents
-        this.countDown = this.closeTimeout;
+        this.countDown = this.config.getNumericSettingValue(NumericParameters.AFKCountdownSecs);
         this.countdownActive = true;
-        this.pixelStreaming.dispatchEvent(
-            new AfkWarningUpdateEvent({ countDown: this.countDown })
-        );
+        this.pixelStreaming.dispatchEvent(new AfkWarningUpdateEvent({ countDown: this.countDown }));
 
         // if we are in locked mouse exit pointerlock
         if (!this.config.isFlagEnabled(Flags.HoveringMouseMode)) {
@@ -137,21 +122,14 @@ export class AFKController {
             this.countDown--;
             if (this.countDown == 0) {
                 // The user failed to click so hide the overlay and disconnect them.
-                this.pixelStreaming.dispatchEvent(
-                    new AfkTimedOutEvent()
-                );
+                this.pixelStreaming.dispatchEvent(new AfkTimedOutEvent());
                 this.onAFKTimedOutCallback();
-                Logger.Log(
-                    Logger.GetStackTrace(),
-                    'You have been disconnected due to inactivity'
-                );
+                Logger.Info('You have been disconnected due to inactivity');
 
                 // switch off the afk feature as stream has closed
                 this.stopAfkWarningTimer();
             } else {
-                this.pixelStreaming.dispatchEvent(
-                    new AfkWarningUpdateEvent({ countDown: this.countDown })
-                );
+                this.pixelStreaming.dispatchEvent(new AfkWarningUpdateEvent({ countDown: this.countDown }));
             }
         }, 1000);
     }