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

package/dist/commonjs/Config/SettingText.js

@@ -1,43 +1,43 @@
-"use strict";
-// Copyright Epic Games, Inc. All Rights Reserved.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SettingText = void 0;
-const SettingBase_1 = require("./SettingBase");
-/**
- * A text setting object with a text label.
- */
-class SettingText extends SettingBase_1.SettingBase {
-    constructor(id, label, description, defaultTextValue, useUrlParams, 
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    defaultOnChangeListener = () => {
-        /* Do nothing, to be overridden. */
-    }) {
-        super(id, label, description, defaultTextValue, defaultOnChangeListener);
-        if (!useUrlParams || !this.hasURLParam(this.id)) {
-            this.text = defaultTextValue;
-        }
-        else {
-            // parse flag from url parameters
-            this.text = this.getURLParam(this.id);
-        }
-        this.useUrlParams = useUrlParams;
-    }
-    getValueAsString() {
-        return this.text;
-    }
-    /**
-     * @return The setting's value.
-     */
-    get text() {
-        return this.value;
-    }
-    /**
-     * Update the setting's stored value.
-     * @param inValue The new value for the setting.
-     */
-    set text(inValue) {
-        this.value = inValue;
-    }
-}
-exports.SettingText = SettingText;
+"use strict";
+// Copyright Epic Games, Inc. All Rights Reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingText = void 0;
+const SettingBase_1 = require("./SettingBase");
+/**
+ * A text setting object with a text label.
+ */
+class SettingText extends SettingBase_1.SettingBase {
+    constructor(id, label, description, defaultTextValue, useUrlParams, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    defaultOnChangeListener = () => {
+        /* Do nothing, to be overridden. */
+    }) {
+        super(id, label, description, defaultTextValue, defaultOnChangeListener);
+        if (!useUrlParams || !this.hasURLParam(this.id)) {
+            this.text = defaultTextValue;
+        }
+        else {
+            // parse flag from url parameters
+            this.text = this.getURLParam(this.id);
+        }
+        this.useUrlParams = useUrlParams;
+    }
+    getValueAsString() {
+        return this.text;
+    }
+    /**
+     * @return The setting's value.
+     */
+    get text() {
+        return this.value;
+    }
+    /**
+     * Update the setting's stored value.
+     * @param inValue The new value for the setting.
+     */
+    set text(inValue) {
+        this.value = inValue;
+    }
+}
+exports.SettingText = SettingText;
 //# sourceMappingURL=SettingText.js.map

package/dist/commonjs/DataChannel/DataChannelController.js

@@ -1,107 +1,107 @@
-"use strict";
-// Copyright Epic Games, Inc. All Rights Reserved.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataChannelController = void 0;
-const lib_pixelstreamingcommon_ue5_5_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5");
-/**
- * Handles the Sending and Receiving of messages to the UE Instance via the Data Channel
- */
-class DataChannelController {
-    constructor() {
-        this.isReceivingFreezeFrame = false;
-    }
-    /**
-     * return the current state of a datachannel controller instance
-     * @returns the current DataChannelController instance
-     */
-    getDataChannelInstance() {
-        return this;
-    }
-    /**
-     * To Create and Set up a Data Channel
-     * @param peerConnection - The RTC Peer Connection
-     * @param label - Label of the Data Channel
-     * @param datachannelOptions - Optional RTC DataChannel options
-     */
-    createDataChannel(peerConnection, label, datachannelOptions) {
-        this.peerConnection = peerConnection;
-        this.label = label;
-        this.datachannelOptions = datachannelOptions;
-        if (datachannelOptions == null) {
-            this.datachannelOptions = {};
-            this.datachannelOptions.ordered = true;
-        }
-        this.dataChannel = this.peerConnection.createDataChannel(this.label, this.datachannelOptions);
-        this.setupDataChannel();
-    }
-    setupDataChannel() {
-        //We Want an Array Buffer not a blob
-        this.dataChannel.binaryType = 'arraybuffer';
-        this.dataChannel.onopen = (ev) => this.handleOnOpen(ev);
-        this.dataChannel.onclose = (ev) => this.handleOnClose(ev);
-        this.dataChannel.onmessage = (ev) => this.handleOnMessage(ev);
-        this.dataChannel.onerror = (ev) => this.handleOnError(ev);
-    }
-    /**
-     * Handles when the Data Channel is opened
-     */
-    handleOnOpen(ev) {
-        var _a;
-        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) opened.`);
-        this.onOpen((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.label, ev);
-    }
-    /**
-     * Handles when the Data Channel is closed
-     */
-    handleOnClose(ev) {
-        var _a;
-        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) closed.`);
-        this.onClose((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.label, ev);
-    }
-    /**
-     * Handles when a message is received
-     * @param event - Message Event
-     */
-    handleOnMessage(event) {
-        // Higher log level to prevent log spam with messages received
-        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) message: ${event}`);
-    }
-    /**
-     * Handles when an error is thrown
-     * @param event - Error Event
-     */
-    handleOnError(event) {
-        var _a;
-        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) error: ${event}`);
-        this.onError((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.label, event);
-    }
-    /**
-     * Override to register onOpen handler
-     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
-     * @param ev event
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    onOpen(label, ev) {
-        // empty default implementation
-    }
-    /**
-     * Override to register onClose handler
-     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
-     * @param ev event
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    onClose(label, ev) {
-        // empty default implementation
-    }
-    /**
-     * Override to register onError handler
-     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
-     * @param ev event
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    onError(label, ev) {
-        // empty default implementation
-    }
-}
-exports.DataChannelController = DataChannelController;
+"use strict";
+// Copyright Epic Games, Inc. All Rights Reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataChannelController = void 0;
+const lib_pixelstreamingcommon_ue5_5_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5");
+/**
+ * Handles the Sending and Receiving of messages to the UE Instance via the Data Channel
+ */
+class DataChannelController {
+    constructor() {
+        this.isReceivingFreezeFrame = false;
+    }
+    /**
+     * return the current state of a datachannel controller instance
+     * @returns the current DataChannelController instance
+     */
+    getDataChannelInstance() {
+        return this;
+    }
+    /**
+     * To Create and Set up a Data Channel
+     * @param peerConnection - The RTC Peer Connection
+     * @param label - Label of the Data Channel
+     * @param datachannelOptions - Optional RTC DataChannel options
+     */
+    createDataChannel(peerConnection, label, datachannelOptions) {
+        this.peerConnection = peerConnection;
+        this.label = label;
+        this.datachannelOptions = datachannelOptions;
+        if (datachannelOptions == null) {
+            this.datachannelOptions = {};
+            this.datachannelOptions.ordered = true;
+        }
+        this.dataChannel = this.peerConnection.createDataChannel(this.label, this.datachannelOptions);
+        this.setupDataChannel();
+    }
+    setupDataChannel() {
+        //We Want an Array Buffer not a blob
+        this.dataChannel.binaryType = 'arraybuffer';
+        this.dataChannel.onopen = (ev) => this.handleOnOpen(ev);
+        this.dataChannel.onclose = (ev) => this.handleOnClose(ev);
+        this.dataChannel.onmessage = (ev) => this.handleOnMessage(ev);
+        this.dataChannel.onerror = (ev) => this.handleOnError(ev);
+    }
+    /**
+     * Handles when the Data Channel is opened
+     */
+    handleOnOpen(ev) {
+        var _a;
+        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) opened.`);
+        this.onOpen((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.label, ev);
+    }
+    /**
+     * Handles when the Data Channel is closed
+     */
+    handleOnClose(ev) {
+        var _a;
+        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) closed.`);
+        this.onClose((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.label, ev);
+    }
+    /**
+     * Handles when a message is received
+     * @param event - Message Event
+     */
+    handleOnMessage(event) {
+        // Higher log level to prevent log spam with messages received
+        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) message: ${event}`);
+    }
+    /**
+     * Handles when an error is thrown
+     * @param event - Error Event
+     */
+    handleOnError(event) {
+        var _a;
+        lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Data Channel (${this.label}) error: ${event}`);
+        this.onError((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.label, event);
+    }
+    /**
+     * Override to register onOpen handler
+     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
+     * @param ev event
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onOpen(label, ev) {
+        // empty default implementation
+    }
+    /**
+     * Override to register onClose handler
+     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
+     * @param ev event
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onClose(label, ev) {
+        // empty default implementation
+    }
+    /**
+     * Override to register onError handler
+     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
+     * @param ev event
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onError(label, ev) {
+        // empty default implementation
+    }
+}
+exports.DataChannelController = DataChannelController;
 //# sourceMappingURL=DataChannelController.js.map

package/dist/commonjs/DataChannel/DataChannelLatencyTestController.js

@@ -1,95 +1,95 @@
-"use strict";
-// Copyright Epic Games, Inc. All Rights Reserved.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataChannelLatencyTestController = void 0;
-const lib_pixelstreamingcommon_ue5_5_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5");
-const DataChannelLatencyTestResults_1 = require("./DataChannelLatencyTestResults");
-class DataChannelLatencyTestController {
-    constructor(sink, callback) {
-        this.intervalHandle = undefined;
-        this.sink = sink;
-        this.callback = callback;
-        this.records = new Map();
-        this.seq = 0;
-    }
-    start(config) {
-        if (this.isRunning()) {
-            return false;
-        }
-        this.startTime = Date.now();
-        this.records.clear();
-        this.intervalHandle = window.setInterval((() => {
-            if (Date.now() - this.startTime >= config.duration) {
-                this.stop();
-            }
-            else {
-                this.sendRequest(config.requestSize, config.responseSize);
-            }
-        }).bind(this), Math.floor(1000 / config.rps));
-        return true;
-    }
-    stop() {
-        if (this.intervalHandle) {
-            window.clearInterval(this.intervalHandle);
-            this.intervalHandle = undefined;
-            this.callback(this.produceResult());
-        }
-    }
-    produceResult() {
-        const resultRecords = new Map(this.records);
-        return {
-            records: resultRecords,
-            dataChannelRtt: Math.ceil(Array.from(this.records.values()).reduce((acc, next) => {
-                return acc + (next.playerReceivedTimestamp - next.playerSentTimestamp);
-            }, 0) / this.records.size),
-            playerToStreamerTime: Math.ceil(Array.from(this.records.values()).reduce((acc, next) => {
-                return acc + (next.streamerReceivedTimestamp - next.playerSentTimestamp);
-            }, 0) / this.records.size),
-            streamerToPlayerTime: Math.ceil(Array.from(this.records.values()).reduce((acc, next) => {
-                return acc + (next.playerReceivedTimestamp - next.streamerSentTimestamp);
-            }, 0) / this.records.size),
-            exportLatencyAsCSV: () => {
-                let csv = 'Timestamp;RTT;PlayerToStreamer;StreamerToPlayer;\n';
-                resultRecords.forEach((record) => {
-                    csv += record.playerSentTimestamp + ';';
-                    csv += record.playerReceivedTimestamp - record.playerSentTimestamp + ';';
-                    csv += record.streamerReceivedTimestamp - record.playerSentTimestamp + ';';
-                    csv += record.playerReceivedTimestamp - record.streamerSentTimestamp + ';';
-                    csv += '\n';
-                });
-                return csv;
-            }
-        };
-    }
-    isRunning() {
-        return !!this.intervalHandle;
-    }
-    receive(response) {
-        if (!this.isRunning()) {
-            return;
-        }
-        if (!response) {
-            lib_pixelstreamingcommon_ue5_5_1.Logger.Error('Undefined response from server');
-            return;
-        }
-        const record = this.records.get(response.Seq);
-        if (record) {
-            record.update(response);
-        }
-    }
-    sendRequest(requestSize, responseSize) {
-        const request = this.createRequest(requestSize, responseSize);
-        const record = new DataChannelLatencyTestResults_1.DataChannelLatencyTestRecord(request);
-        this.records.set(record.seq, record);
-        this.sink(request);
-    }
-    createRequest(requestSize, responseSize) {
-        return {
-            Seq: this.seq++,
-            FillResponseSize: responseSize,
-            Filler: requestSize ? 'A'.repeat(requestSize) : ''
-        };
-    }
-}
-exports.DataChannelLatencyTestController = DataChannelLatencyTestController;
+"use strict";
+// Copyright Epic Games, Inc. All Rights Reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataChannelLatencyTestController = void 0;
+const lib_pixelstreamingcommon_ue5_5_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5");
+const DataChannelLatencyTestResults_1 = require("./DataChannelLatencyTestResults");
+class DataChannelLatencyTestController {
+    constructor(sink, callback) {
+        this.intervalHandle = undefined;
+        this.sink = sink;
+        this.callback = callback;
+        this.records = new Map();
+        this.seq = 0;
+    }
+    start(config) {
+        if (this.isRunning()) {
+            return false;
+        }
+        this.startTime = Date.now();
+        this.records.clear();
+        this.intervalHandle = window.setInterval((() => {
+            if (Date.now() - this.startTime >= config.duration) {
+                this.stop();
+            }
+            else {
+                this.sendRequest(config.requestSize, config.responseSize);
+            }
+        }).bind(this), Math.floor(1000 / config.rps));
+        return true;
+    }
+    stop() {
+        if (this.intervalHandle) {
+            window.clearInterval(this.intervalHandle);
+            this.intervalHandle = undefined;
+            this.callback(this.produceResult());
+        }
+    }
+    produceResult() {
+        const resultRecords = new Map(this.records);
+        return {
+            records: resultRecords,
+            dataChannelRtt: Math.ceil(Array.from(this.records.values()).reduce((acc, next) => {
+                return acc + (next.playerReceivedTimestamp - next.playerSentTimestamp);
+            }, 0) / this.records.size),
+            playerToStreamerTime: Math.ceil(Array.from(this.records.values()).reduce((acc, next) => {
+                return acc + (next.streamerReceivedTimestamp - next.playerSentTimestamp);
+            }, 0) / this.records.size),
+            streamerToPlayerTime: Math.ceil(Array.from(this.records.values()).reduce((acc, next) => {
+                return acc + (next.playerReceivedTimestamp - next.streamerSentTimestamp);
+            }, 0) / this.records.size),
+            exportLatencyAsCSV: () => {
+                let csv = 'Timestamp;RTT;PlayerToStreamer;StreamerToPlayer;\n';
+                resultRecords.forEach((record) => {
+                    csv += record.playerSentTimestamp + ';';
+                    csv += record.playerReceivedTimestamp - record.playerSentTimestamp + ';';
+                    csv += record.streamerReceivedTimestamp - record.playerSentTimestamp + ';';
+                    csv += record.playerReceivedTimestamp - record.streamerSentTimestamp + ';';
+                    csv += '\n';
+                });
+                return csv;
+            }
+        };
+    }
+    isRunning() {
+        return !!this.intervalHandle;
+    }
+    receive(response) {
+        if (!this.isRunning()) {
+            return;
+        }
+        if (!response) {
+            lib_pixelstreamingcommon_ue5_5_1.Logger.Error('Undefined response from server');
+            return;
+        }
+        const record = this.records.get(response.Seq);
+        if (record) {
+            record.update(response);
+        }
+    }
+    sendRequest(requestSize, responseSize) {
+        const request = this.createRequest(requestSize, responseSize);
+        const record = new DataChannelLatencyTestResults_1.DataChannelLatencyTestRecord(request);
+        this.records.set(record.seq, record);
+        this.sink(request);
+    }
+    createRequest(requestSize, responseSize) {
+        return {
+            Seq: this.seq++,
+            FillResponseSize: responseSize,
+            Filler: requestSize ? 'A'.repeat(requestSize) : ''
+        };
+    }
+}
+exports.DataChannelLatencyTestController = DataChannelLatencyTestController;
 //# sourceMappingURL=DataChannelLatencyTestController.js.map

package/dist/commonjs/DataChannel/DataChannelLatencyTestResults.js

@@ -1,19 +1,19 @@
-"use strict";
-// Copyright Epic Games, Inc. All Rights Reserved.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataChannelLatencyTestRecord = void 0;
-class DataChannelLatencyTestRecord {
-    constructor(request) {
-        this.seq = request.Seq;
-        this.playerSentTimestamp = Date.now();
-        this.requestFillerSize = request.Filler ? request.Filler.length : 0;
-    }
-    update(response) {
-        this.playerReceivedTimestamp = Date.now();
-        this.streamerReceivedTimestamp = response.ReceivedTimestamp;
-        this.streamerSentTimestamp = response.SentTimestamp;
-        this.responseFillerSize = response.Filler ? response.Filler.length : 0;
-    }
-}
-exports.DataChannelLatencyTestRecord = DataChannelLatencyTestRecord;
+"use strict";
+// Copyright Epic Games, Inc. All Rights Reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataChannelLatencyTestRecord = void 0;
+class DataChannelLatencyTestRecord {
+    constructor(request) {
+        this.seq = request.Seq;
+        this.playerSentTimestamp = Date.now();
+        this.requestFillerSize = request.Filler ? request.Filler.length : 0;
+    }
+    update(response) {
+        this.playerReceivedTimestamp = Date.now();
+        this.streamerReceivedTimestamp = response.ReceivedTimestamp;
+        this.streamerSentTimestamp = response.SentTimestamp;
+        this.responseFillerSize = response.Filler ? response.Filler.length : 0;
+    }
+}
+exports.DataChannelLatencyTestRecord = DataChannelLatencyTestRecord;
 //# sourceMappingURL=DataChannelLatencyTestResults.js.map

package/dist/commonjs/DataChannel/DataChannelSender.js

@@ -1,44 +1,44 @@
-"use strict";
-// Copyright Epic Games, Inc. All Rights Reserved.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataChannelSender = void 0;
-const lib_pixelstreamingcommon_ue5_5_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5");
-/**
- * A class for sending data channel messages
- */
-class DataChannelSender {
-    /**
-     * @param dataChannelProvider - Data channel object type
-     */
-    constructor(dataChannelProvider) {
-        this.dataChannelProvider = dataChannelProvider;
-    }
-    canSend() {
-        return (this.dataChannelProvider.getDataChannelInstance().dataChannel !== undefined &&
-            this.dataChannelProvider.getDataChannelInstance().dataChannel.readyState == 'open');
-    }
-    /**
-     * Send Data over the Data channel to the UE Instance
-     * @param data - Message Data Array Buffer
-     */
-    sendData(data) {
-        // reset the afk inactivity
-        const dataChannelInstance = this.dataChannelProvider.getDataChannelInstance();
-        if (dataChannelInstance.dataChannel.readyState == 'open') {
-            dataChannelInstance.dataChannel.send(data);
-            lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Message Sent: ${new Uint8Array(data)}`);
-            this.resetAfkWarningTimerOnDataSend();
-        }
-        else {
-            lib_pixelstreamingcommon_ue5_5_1.Logger.Error(`Message Failed: ${new Uint8Array(data)}`);
-        }
-    }
-    /**
-     * An override method for resetting the Afk warning timer when data is sent over the data channel
-     */
-    resetAfkWarningTimerOnDataSend() {
-        // Base Functionality: Do Nothing
-    }
-}
-exports.DataChannelSender = DataChannelSender;
+"use strict";
+// Copyright Epic Games, Inc. All Rights Reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataChannelSender = void 0;
+const lib_pixelstreamingcommon_ue5_5_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.5");
+/**
+ * A class for sending data channel messages
+ */
+class DataChannelSender {
+    /**
+     * @param dataChannelProvider - Data channel object type
+     */
+    constructor(dataChannelProvider) {
+        this.dataChannelProvider = dataChannelProvider;
+    }
+    canSend() {
+        return (this.dataChannelProvider.getDataChannelInstance().dataChannel !== undefined &&
+            this.dataChannelProvider.getDataChannelInstance().dataChannel.readyState == 'open');
+    }
+    /**
+     * Send Data over the Data channel to the UE Instance
+     * @param data - Message Data Array Buffer
+     */
+    sendData(data) {
+        // reset the afk inactivity
+        const dataChannelInstance = this.dataChannelProvider.getDataChannelInstance();
+        if (dataChannelInstance.dataChannel.readyState == 'open') {
+            dataChannelInstance.dataChannel.send(data);
+            lib_pixelstreamingcommon_ue5_5_1.Logger.Info(`Message Sent: ${new Uint8Array(data)}`);
+            this.resetAfkWarningTimerOnDataSend();
+        }
+        else {
+            lib_pixelstreamingcommon_ue5_5_1.Logger.Error(`Message Failed: ${new Uint8Array(data)}`);
+        }
+    }
+    /**
+     * An override method for resetting the Afk warning timer when data is sent over the data channel
+     */
+    resetAfkWarningTimerOnDataSend() {
+        // Base Functionality: Do Nothing
+    }
+}
+exports.DataChannelSender = DataChannelSender;
 //# sourceMappingURL=DataChannelSender.js.map