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

package/dist/commonjs/pixelstreamingfrontend.js

@@ -1,71 +1,71 @@
-"use strict";
-// Copyright Epic Games, Inc. All Rights Reserved.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutBoundVideoStats = exports.InboundVideoStats = exports.InboundAudioStats = exports.DataChannelStats = exports.CandidateStat = exports.CandidatePairStats = exports.MessageDirection = exports.InputCoordTranslator = exports.AggregatedStats = exports.PixelStreamingSettings = exports.WebRTCSettings = exports.InitialSettings = exports.EncoderSettings = exports.LatencyTestResults = exports.AfkLogic = exports.PixelStreaming = exports.SettingText = exports.SettingOption = exports.SettingNumber = exports.SettingFlag = exports.SettingBase = exports.OptionParameters = exports.TextParameters = exports.NumericParameters = exports.Flags = exports.ControlSchemeType = exports.Config = exports.WebXRController = exports.WebRtcPlayerController = void 0;
-var WebRtcPlayerController_1 = require("./WebRtcPlayer/WebRtcPlayerController");
-Object.defineProperty(exports, "WebRtcPlayerController", { enumerable: true, get: function () { return WebRtcPlayerController_1.WebRtcPlayerController; } });
-var WebXRController_1 = require("./WebXR/WebXRController");
-Object.defineProperty(exports, "WebXRController", { enumerable: true, get: function () { return WebXRController_1.WebXRController; } });
-var Config_1 = require("./Config/Config");
-Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return Config_1.Config; } });
-Object.defineProperty(exports, "ControlSchemeType", { enumerable: true, get: function () { return Config_1.ControlSchemeType; } });
-Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return Config_1.Flags; } });
-Object.defineProperty(exports, "NumericParameters", { enumerable: true, get: function () { return Config_1.NumericParameters; } });
-Object.defineProperty(exports, "TextParameters", { enumerable: true, get: function () { return Config_1.TextParameters; } });
-Object.defineProperty(exports, "OptionParameters", { enumerable: true, get: function () { return Config_1.OptionParameters; } });
-var SettingBase_1 = require("./Config/SettingBase");
-Object.defineProperty(exports, "SettingBase", { enumerable: true, get: function () { return SettingBase_1.SettingBase; } });
-var SettingFlag_1 = require("./Config/SettingFlag");
-Object.defineProperty(exports, "SettingFlag", { enumerable: true, get: function () { return SettingFlag_1.SettingFlag; } });
-var SettingNumber_1 = require("./Config/SettingNumber");
-Object.defineProperty(exports, "SettingNumber", { enumerable: true, get: function () { return SettingNumber_1.SettingNumber; } });
-var SettingOption_1 = require("./Config/SettingOption");
-Object.defineProperty(exports, "SettingOption", { enumerable: true, get: function () { return SettingOption_1.SettingOption; } });
-var SettingText_1 = require("./Config/SettingText");
-Object.defineProperty(exports, "SettingText", { enumerable: true, get: function () { return SettingText_1.SettingText; } });
-var PixelStreaming_1 = require("./PixelStreaming/PixelStreaming");
-Object.defineProperty(exports, "PixelStreaming", { enumerable: true, get: function () { return PixelStreaming_1.PixelStreaming; } });
-var AFKController_1 = require("./AFK/AFKController");
-Object.defineProperty(exports, "AfkLogic", { enumerable: true, get: function () { return AFKController_1.AFKController; } });
-var LatencyTestResults_1 = require("./DataChannel/LatencyTestResults");
-Object.defineProperty(exports, "LatencyTestResults", { enumerable: true, get: function () { return LatencyTestResults_1.LatencyTestResults; } });
-var InitialSettings_1 = require("./DataChannel/InitialSettings");
-Object.defineProperty(exports, "EncoderSettings", { enumerable: true, get: function () { return InitialSettings_1.EncoderSettings; } });
-Object.defineProperty(exports, "InitialSettings", { enumerable: true, get: function () { return InitialSettings_1.InitialSettings; } });
-Object.defineProperty(exports, "WebRTCSettings", { enumerable: true, get: function () { return InitialSettings_1.WebRTCSettings; } });
-Object.defineProperty(exports, "PixelStreamingSettings", { enumerable: true, get: function () { return InitialSettings_1.PixelStreamingSettings; } });
-var AggregatedStats_1 = require("./PeerConnectionController/AggregatedStats");
-Object.defineProperty(exports, "AggregatedStats", { enumerable: true, get: function () { return AggregatedStats_1.AggregatedStats; } });
-var InputCoordTranslator_1 = require("./Util/InputCoordTranslator");
-Object.defineProperty(exports, "InputCoordTranslator", { enumerable: true, get: function () { return InputCoordTranslator_1.InputCoordTranslator; } });
-var StreamMessageController_1 = require("./UeInstanceMessage/StreamMessageController");
-Object.defineProperty(exports, "MessageDirection", { enumerable: true, get: function () { return StreamMessageController_1.MessageDirection; } });
-var CandidatePairStats_1 = require("./PeerConnectionController/CandidatePairStats");
-Object.defineProperty(exports, "CandidatePairStats", { enumerable: true, get: function () { return CandidatePairStats_1.CandidatePairStats; } });
-var CandidateStat_1 = require("./PeerConnectionController/CandidateStat");
-Object.defineProperty(exports, "CandidateStat", { enumerable: true, get: function () { return CandidateStat_1.CandidateStat; } });
-var DataChannelStats_1 = require("./PeerConnectionController/DataChannelStats");
-Object.defineProperty(exports, "DataChannelStats", { enumerable: true, get: function () { return DataChannelStats_1.DataChannelStats; } });
-var InboundRTPStats_1 = require("./PeerConnectionController/InboundRTPStats");
-Object.defineProperty(exports, "InboundAudioStats", { enumerable: true, get: function () { return InboundRTPStats_1.InboundAudioStats; } });
-Object.defineProperty(exports, "InboundVideoStats", { enumerable: true, get: function () { return InboundRTPStats_1.InboundVideoStats; } });
-var OutBoundRTPStats_1 = require("./PeerConnectionController/OutBoundRTPStats");
-Object.defineProperty(exports, "OutBoundVideoStats", { enumerable: true, get: function () { return OutBoundRTPStats_1.OutBoundVideoStats; } });
-__exportStar(require("./DataChannel/DataChannelLatencyTestResults"), exports);
-__exportStar(require("./Util/EventEmitter"), exports);
-__exportStar(require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5"), exports);
+"use strict";
+// Copyright Epic Games, Inc. All Rights Reserved.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutBoundVideoStats = exports.InboundVideoStats = exports.InboundAudioStats = exports.DataChannelStats = exports.CandidateStat = exports.CandidatePairStats = exports.MessageDirection = exports.InputCoordTranslator = exports.AggregatedStats = exports.PixelStreamingSettings = exports.WebRTCSettings = exports.InitialSettings = exports.EncoderSettings = exports.LatencyTestResults = exports.AfkLogic = exports.PixelStreaming = exports.SettingText = exports.SettingOption = exports.SettingNumber = exports.SettingFlag = exports.SettingBase = exports.OptionParameters = exports.TextParameters = exports.NumericParameters = exports.Flags = exports.ControlSchemeType = exports.Config = exports.WebXRController = exports.WebRtcPlayerController = void 0;
+var WebRtcPlayerController_1 = require("./WebRtcPlayer/WebRtcPlayerController");
+Object.defineProperty(exports, "WebRtcPlayerController", { enumerable: true, get: function () { return WebRtcPlayerController_1.WebRtcPlayerController; } });
+var WebXRController_1 = require("./WebXR/WebXRController");
+Object.defineProperty(exports, "WebXRController", { enumerable: true, get: function () { return WebXRController_1.WebXRController; } });
+var Config_1 = require("./Config/Config");
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return Config_1.Config; } });
+Object.defineProperty(exports, "ControlSchemeType", { enumerable: true, get: function () { return Config_1.ControlSchemeType; } });
+Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return Config_1.Flags; } });
+Object.defineProperty(exports, "NumericParameters", { enumerable: true, get: function () { return Config_1.NumericParameters; } });
+Object.defineProperty(exports, "TextParameters", { enumerable: true, get: function () { return Config_1.TextParameters; } });
+Object.defineProperty(exports, "OptionParameters", { enumerable: true, get: function () { return Config_1.OptionParameters; } });
+var SettingBase_1 = require("./Config/SettingBase");
+Object.defineProperty(exports, "SettingBase", { enumerable: true, get: function () { return SettingBase_1.SettingBase; } });
+var SettingFlag_1 = require("./Config/SettingFlag");
+Object.defineProperty(exports, "SettingFlag", { enumerable: true, get: function () { return SettingFlag_1.SettingFlag; } });
+var SettingNumber_1 = require("./Config/SettingNumber");
+Object.defineProperty(exports, "SettingNumber", { enumerable: true, get: function () { return SettingNumber_1.SettingNumber; } });
+var SettingOption_1 = require("./Config/SettingOption");
+Object.defineProperty(exports, "SettingOption", { enumerable: true, get: function () { return SettingOption_1.SettingOption; } });
+var SettingText_1 = require("./Config/SettingText");
+Object.defineProperty(exports, "SettingText", { enumerable: true, get: function () { return SettingText_1.SettingText; } });
+var PixelStreaming_1 = require("./PixelStreaming/PixelStreaming");
+Object.defineProperty(exports, "PixelStreaming", { enumerable: true, get: function () { return PixelStreaming_1.PixelStreaming; } });
+var AFKController_1 = require("./AFK/AFKController");
+Object.defineProperty(exports, "AfkLogic", { enumerable: true, get: function () { return AFKController_1.AFKController; } });
+var LatencyTestResults_1 = require("./DataChannel/LatencyTestResults");
+Object.defineProperty(exports, "LatencyTestResults", { enumerable: true, get: function () { return LatencyTestResults_1.LatencyTestResults; } });
+var InitialSettings_1 = require("./DataChannel/InitialSettings");
+Object.defineProperty(exports, "EncoderSettings", { enumerable: true, get: function () { return InitialSettings_1.EncoderSettings; } });
+Object.defineProperty(exports, "InitialSettings", { enumerable: true, get: function () { return InitialSettings_1.InitialSettings; } });
+Object.defineProperty(exports, "WebRTCSettings", { enumerable: true, get: function () { return InitialSettings_1.WebRTCSettings; } });
+Object.defineProperty(exports, "PixelStreamingSettings", { enumerable: true, get: function () { return InitialSettings_1.PixelStreamingSettings; } });
+var AggregatedStats_1 = require("./PeerConnectionController/AggregatedStats");
+Object.defineProperty(exports, "AggregatedStats", { enumerable: true, get: function () { return AggregatedStats_1.AggregatedStats; } });
+var InputCoordTranslator_1 = require("./Util/InputCoordTranslator");
+Object.defineProperty(exports, "InputCoordTranslator", { enumerable: true, get: function () { return InputCoordTranslator_1.InputCoordTranslator; } });
+var StreamMessageController_1 = require("./UeInstanceMessage/StreamMessageController");
+Object.defineProperty(exports, "MessageDirection", { enumerable: true, get: function () { return StreamMessageController_1.MessageDirection; } });
+var CandidatePairStats_1 = require("./PeerConnectionController/CandidatePairStats");
+Object.defineProperty(exports, "CandidatePairStats", { enumerable: true, get: function () { return CandidatePairStats_1.CandidatePairStats; } });
+var CandidateStat_1 = require("./PeerConnectionController/CandidateStat");
+Object.defineProperty(exports, "CandidateStat", { enumerable: true, get: function () { return CandidateStat_1.CandidateStat; } });
+var DataChannelStats_1 = require("./PeerConnectionController/DataChannelStats");
+Object.defineProperty(exports, "DataChannelStats", { enumerable: true, get: function () { return DataChannelStats_1.DataChannelStats; } });
+var InboundRTPStats_1 = require("./PeerConnectionController/InboundRTPStats");
+Object.defineProperty(exports, "InboundAudioStats", { enumerable: true, get: function () { return InboundRTPStats_1.InboundAudioStats; } });
+Object.defineProperty(exports, "InboundVideoStats", { enumerable: true, get: function () { return InboundRTPStats_1.InboundVideoStats; } });
+var OutBoundRTPStats_1 = require("./PeerConnectionController/OutBoundRTPStats");
+Object.defineProperty(exports, "OutBoundVideoStats", { enumerable: true, get: function () { return OutBoundRTPStats_1.OutBoundVideoStats; } });
+__exportStar(require("./DataChannel/DataChannelLatencyTestResults"), exports);
+__exportStar(require("./Util/EventEmitter"), exports);
+__exportStar(require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5"), exports);
 //# sourceMappingURL=pixelstreamingfrontend.js.map

package/dist/esm/AFK/AFKController.js

@@ -1,106 +1,106 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-import { Flags, NumericParameters } from '../Config/Config';
-import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
-import { AfkTimedOutEvent, AfkWarningActivateEvent, AfkWarningDeactivateEvent, AfkWarningUpdateEvent } from '../Util/EventEmitter';
-export class AFKController {
-    constructor(config, pixelStreaming, onDismissAfk) {
-        // time out logic details
-        this.active = false;
-        this.countdownActive = false;
-        this.warnTimer = undefined;
-        this.countDown = 0;
-        this.countDownTimer = undefined;
-        this.config = config;
-        this.pixelStreaming = pixelStreaming;
-        this.onDismissAfk = onDismissAfk;
-        this.onAFKTimedOutCallback = () => {
-            console.log('AFK timed out, did you want to override this callback?');
-        };
-    }
-    /**
-     * The methods that occur when an afk event listener is clicked
-     */
-    onAfkClick() {
-        clearInterval(this.countDownTimer);
-        if (this.active || this.countdownActive) {
-            this.startAfkWarningTimer();
-            this.pixelStreaming.dispatchEvent(new AfkWarningDeactivateEvent());
-        }
-    }
-    /**
-     * Start the warning timer if a timeout is set greater that 0 seconds
-     */
-    startAfkWarningTimer() {
-        if (this.config.getNumericSettingValue(NumericParameters.AFKTimeoutSecs) > 0 &&
-            this.config.isFlagEnabled(Flags.AFKDetection)) {
-            this.active = true;
-        }
-        else {
-            this.active = false;
-        }
-        this.resetAfkWarningTimer();
-    }
-    /**
-     * Stop the afk warning timer
-     */
-    stopAfkWarningTimer() {
-        this.active = false;
-        this.countdownActive = false;
-        clearTimeout(this.warnTimer);
-        clearInterval(this.countDownTimer);
-    }
-    /**
-     * Pause the timer which when elapsed will warn the user they are inactive.
-     */
-    pauseAfkWarningTimer() {
-        this.active = false;
-    }
-    /**
-     * If the user interacts then reset the warning timer.
-     */
-    resetAfkWarningTimer() {
-        if (this.active && this.config.isFlagEnabled(Flags.AFKDetection)) {
-            clearTimeout(this.warnTimer);
-            this.warnTimer = setTimeout(() => this.activateAfkEvent(), this.config.getNumericSettingValue(NumericParameters.AFKTimeoutSecs) * 1000);
-        }
-    }
-    /**
-     * Show the AFK overlay and begin the countDown
-     */
-    activateAfkEvent() {
-        // Pause the timer while the user is looking at the inactivity warning overlay
-        this.pauseAfkWarningTimer();
-        // instantiate a new overlay
-        this.pixelStreaming.dispatchEvent(new AfkWarningActivateEvent({
-            countDown: this.countDown,
-            dismissAfk: this.onDismissAfk
-        }));
-        // update our countDown timer and overlay contents
-        this.countDown = this.config.getNumericSettingValue(NumericParameters.AFKCountdownSecs);
-        this.countdownActive = true;
-        this.pixelStreaming.dispatchEvent(new AfkWarningUpdateEvent({ countDown: this.countDown }));
-        // if we are in locked mouse exit pointerlock
-        if (!this.config.isFlagEnabled(Flags.HoveringMouseMode)) {
-            // minor hack to alleviate ios not supporting pointerlock
-            if (document.exitPointerLock) {
-                document.exitPointerLock();
-            }
-        }
-        // reset our countDown interval accordingly
-        this.countDownTimer = setInterval(() => {
-            this.countDown--;
-            if (this.countDown == 0) {
-                // The user failed to click so hide the overlay and disconnect them.
-                this.pixelStreaming.dispatchEvent(new AfkTimedOutEvent());
-                this.onAFKTimedOutCallback();
-                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 }));
-            }
-        }, 1000);
-    }
-}
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { Flags, NumericParameters } from '../Config/Config';
+import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
+import { AfkTimedOutEvent, AfkWarningActivateEvent, AfkWarningDeactivateEvent, AfkWarningUpdateEvent } from '../Util/EventEmitter';
+export class AFKController {
+    constructor(config, pixelStreaming, onDismissAfk) {
+        // time out logic details
+        this.active = false;
+        this.countdownActive = false;
+        this.warnTimer = undefined;
+        this.countDown = 0;
+        this.countDownTimer = undefined;
+        this.config = config;
+        this.pixelStreaming = pixelStreaming;
+        this.onDismissAfk = onDismissAfk;
+        this.onAFKTimedOutCallback = () => {
+            console.log('AFK timed out, did you want to override this callback?');
+        };
+    }
+    /**
+     * The methods that occur when an afk event listener is clicked
+     */
+    onAfkClick() {
+        clearInterval(this.countDownTimer);
+        if (this.active || this.countdownActive) {
+            this.startAfkWarningTimer();
+            this.pixelStreaming.dispatchEvent(new AfkWarningDeactivateEvent());
+        }
+    }
+    /**
+     * Start the warning timer if a timeout is set greater that 0 seconds
+     */
+    startAfkWarningTimer() {
+        if (this.config.getNumericSettingValue(NumericParameters.AFKTimeoutSecs) > 0 &&
+            this.config.isFlagEnabled(Flags.AFKDetection)) {
+            this.active = true;
+        }
+        else {
+            this.active = false;
+        }
+        this.resetAfkWarningTimer();
+    }
+    /**
+     * Stop the afk warning timer
+     */
+    stopAfkWarningTimer() {
+        this.active = false;
+        this.countdownActive = false;
+        clearTimeout(this.warnTimer);
+        clearInterval(this.countDownTimer);
+    }
+    /**
+     * Pause the timer which when elapsed will warn the user they are inactive.
+     */
+    pauseAfkWarningTimer() {
+        this.active = false;
+    }
+    /**
+     * If the user interacts then reset the warning timer.
+     */
+    resetAfkWarningTimer() {
+        if (this.active && this.config.isFlagEnabled(Flags.AFKDetection)) {
+            clearTimeout(this.warnTimer);
+            this.warnTimer = setTimeout(() => this.activateAfkEvent(), this.config.getNumericSettingValue(NumericParameters.AFKTimeoutSecs) * 1000);
+        }
+    }
+    /**
+     * Show the AFK overlay and begin the countDown
+     */
+    activateAfkEvent() {
+        // Pause the timer while the user is looking at the inactivity warning overlay
+        this.pauseAfkWarningTimer();
+        // instantiate a new overlay
+        this.pixelStreaming.dispatchEvent(new AfkWarningActivateEvent({
+            countDown: this.countDown,
+            dismissAfk: this.onDismissAfk
+        }));
+        // update our countDown timer and overlay contents
+        this.countDown = this.config.getNumericSettingValue(NumericParameters.AFKCountdownSecs);
+        this.countdownActive = true;
+        this.pixelStreaming.dispatchEvent(new AfkWarningUpdateEvent({ countDown: this.countDown }));
+        // if we are in locked mouse exit pointerlock
+        if (!this.config.isFlagEnabled(Flags.HoveringMouseMode)) {
+            // minor hack to alleviate ios not supporting pointerlock
+            if (document.exitPointerLock) {
+                document.exitPointerLock();
+            }
+        }
+        // reset our countDown interval accordingly
+        this.countDownTimer = setInterval(() => {
+            this.countDown--;
+            if (this.countDown == 0) {
+                // The user failed to click so hide the overlay and disconnect them.
+                this.pixelStreaming.dispatchEvent(new AfkTimedOutEvent());
+                this.onAFKTimedOutCallback();
+                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 }));
+            }
+        }, 1000);
+    }
+}
 //# sourceMappingURL=AFKController.js.map