@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.4.1 → 0.4.3

package/src/Util/EventEmitter.ts

@@ -17,7 +17,7 @@ import {
  * Can be cancelled by calling the callback function provided as part of the event.
  */
 export class AfkWarningActivateEvent extends Event {
-    readonly type: 'afkWarningActivate';
+    override readonly type: 'afkWarningActivate';
     readonly data: {
         /** How many seconds until the session is disconnected */
         countDown: number;
@@ -34,7 +34,7 @@ export class AfkWarningActivateEvent extends Event {
  * An event that is emitted when the AFK disconnect countdown is updated.
  */
 export class AfkWarningUpdateEvent extends Event {
-    readonly type: 'afkWarningUpdate';
+    override readonly type: 'afkWarningUpdate';
     readonly data: {
         /** How many seconds until the session is disconnected */
         countDown: number;
@@ -49,7 +49,7 @@ export class AfkWarningUpdateEvent extends Event {
  * An event that is emitted when AFK warning is deactivated.
  */
 export class AfkWarningDeactivateEvent extends Event {
-    readonly type: 'afkWarningDeactivate';
+    override readonly type: 'afkWarningDeactivate';
     constructor() {
         super('afkWarningDeactivate');
     }
@@ -59,7 +59,7 @@ export class AfkWarningDeactivateEvent extends Event {
  * An event that is emitted when AFK countdown reaches 0 and the user is disconnected.
  */
 export class AfkTimedOutEvent extends Event {
-    readonly type: 'afkTimedOut';
+    override readonly type: 'afkTimedOut';
     constructor() {
         super('afkTimedOut');
     }
@@ -69,7 +69,7 @@ export class AfkTimedOutEvent extends Event {
  * An event that is emitted when we receive new video quality value.
  */
 export class VideoEncoderAvgQPEvent extends Event {
-    readonly type: 'videoEncoderAvgQP';
+    override readonly type: 'videoEncoderAvgQP';
     readonly data: {
         /** Average video quality value */
         avgQP: number;
@@ -84,7 +84,7 @@ export class VideoEncoderAvgQPEvent extends Event {
  * An event that is emitted after a WebRtc connection has been negotiated.
  */
 export class WebRtcSdpEvent extends Event {
-    readonly type: 'webRtcSdp';
+    override readonly type: 'webRtcSdp';
     constructor() {
         super('webRtcSdp');
     }
@@ -94,7 +94,7 @@ export class WebRtcSdpEvent extends Event {
  * An event that is emitted when auto connecting.
  */
 export class WebRtcAutoConnectEvent extends Event {
-    readonly type: 'webRtcAutoConnect';
+    override readonly type: 'webRtcAutoConnect';
     constructor() {
         super('webRtcAutoConnect');
     }
@@ -104,7 +104,7 @@ export class WebRtcAutoConnectEvent extends Event {
  * An event that is emitted when sending a WebRtc offer.
  */
 export class WebRtcConnectingEvent extends Event {
-    readonly type: 'webRtcConnecting';
+    override readonly type: 'webRtcConnecting';
     constructor() {
         super('webRtcConnecting');
     }
@@ -114,7 +114,7 @@ export class WebRtcConnectingEvent extends Event {
  * An event that is emitted when WebRtc connection has been established.
  */
 export class WebRtcConnectedEvent extends Event {
-    readonly type: 'webRtcConnected';
+    override readonly type: 'webRtcConnected';
     constructor() {
         super('webRtcConnected');
     }
@@ -124,7 +124,7 @@ export class WebRtcConnectedEvent extends Event {
  * An event that is emitted if WebRtc connection has failed.
  */
 export class WebRtcFailedEvent extends Event {
-    readonly type: 'webRtcFailed';
+    override readonly type: 'webRtcFailed';
     constructor() {
         super('webRtcFailed');
     }
@@ -134,7 +134,7 @@ export class WebRtcFailedEvent extends Event {
  * An event that is emitted if WebRtc connection is disconnected.
  */
 export class WebRtcDisconnectedEvent extends Event {
-    readonly type: 'webRtcDisconnected';
+    override readonly type: 'webRtcDisconnected';
     readonly data: {
         /** Message describing the disconnect reason */
         eventString: string;
@@ -151,7 +151,7 @@ export class WebRtcDisconnectedEvent extends Event {
  * An event that is emitted when RTCDataChannel is opened.
  */
 export class DataChannelOpenEvent extends Event {
-    readonly type: 'dataChannelOpen';
+    override readonly type: 'dataChannelOpen';
     readonly data: {
         /** Data channel label. One of 'datachannel', 'send-datachannel', 'recv-datachannel' */
         label: string;
@@ -168,7 +168,7 @@ export class DataChannelOpenEvent extends Event {
  * An event that is emitted when RTCDataChannel is closed.
  */
 export class DataChannelCloseEvent extends Event {
-    readonly type: 'dataChannelClose';
+    override readonly type: 'dataChannelClose';
     readonly data: {
         /** Data channel label. One of 'datachannel', 'send-datachannel', 'recv-datachannel' */
         label: string;
@@ -185,7 +185,7 @@ export class DataChannelCloseEvent extends Event {
  * An event that is emitted on RTCDataChannel errors.
  */
 export class DataChannelErrorEvent extends Event {
-    readonly type: 'dataChannelError';
+    override readonly type: 'dataChannelError';
     readonly data: {
         /** Data channel label. One of 'datachannel', 'send-datachannel', 'recv-datachannel' */
         label: string;
@@ -202,7 +202,7 @@ export class DataChannelErrorEvent extends Event {
  * An event that is emitted when the video stream has been initialized.
  */
 export class VideoInitializedEvent extends Event {
-    readonly type: 'videoInitialized';
+    override readonly type: 'videoInitialized';
     constructor() {
         super('videoInitialized');
     }
@@ -212,7 +212,7 @@ export class VideoInitializedEvent extends Event {
  * An event that is emitted when video stream loading starts.
  */
 export class StreamLoadingEvent extends Event {
-    readonly type: 'streamLoading';
+    override readonly type: 'streamLoading';
     constructor() {
         super('streamLoading');
     }
@@ -222,7 +222,7 @@ export class StreamLoadingEvent extends Event {
  * An event that is emitted when video stream loading has finished.
  */
 export class StreamPreConnectEvent extends Event {
-    readonly type: 'streamConnect';
+    override readonly type: 'streamConnect';
     constructor() {
         super('streamConnect');
     }
@@ -232,7 +232,7 @@ export class StreamPreConnectEvent extends Event {
  * An event that is emitted when video stream has stopped.
  */
 export class StreamPreDisconnectEvent extends Event {
-    readonly type: 'streamDisconnect';
+    override readonly type: 'streamDisconnect';
     constructor() {
         super('streamDisconnect');
     }
@@ -242,7 +242,7 @@ export class StreamPreDisconnectEvent extends Event {
  * An event that is emitted when video stream is reconnecting.
  */
 export class StreamReconnectEvent extends Event {
-    readonly type: 'streamReconnect';
+    override readonly type: 'streamReconnect';
     constructor() {
         super('streamReconnect');
     }
@@ -252,7 +252,7 @@ export class StreamReconnectEvent extends Event {
  * An event that is emitted if there are errors loading the video stream.
  */
 export class PlayStreamErrorEvent extends Event {
-    readonly type: 'playStreamError';
+    override readonly type: 'playStreamError';
     readonly data: {
         /** Error message */
         message: string;
@@ -267,7 +267,7 @@ export class PlayStreamErrorEvent extends Event {
  * An event that is emitted before trying to start video playback.
  */
 export class PlayStreamEvent extends Event {
-    readonly type: 'playStream';
+    override readonly type: 'playStream';
     constructor() {
         super('playStream');
     }
@@ -278,7 +278,7 @@ export class PlayStreamEvent extends Event {
  * video auto-play without user interaction is refused by the browser.
  */
 export class PlayStreamRejectedEvent extends Event {
-    readonly type: 'playStreamRejected';
+    override readonly type: 'playStreamRejected';
     readonly data: {
         /** Rejection reason */
         reason: unknown;
@@ -293,7 +293,7 @@ export class PlayStreamRejectedEvent extends Event {
  * An event that is emitted when receiving a full FreezeFrame image from UE.
  */
 export class LoadFreezeFrameEvent extends Event {
-    readonly type: 'loadFreezeFrame';
+    override readonly type: 'loadFreezeFrame';
     readonly data: {
         /** true if should show click-to-play overlay, not the freeze frame contents */
         shouldShowPlayOverlay: boolean;
@@ -312,7 +312,7 @@ export class LoadFreezeFrameEvent extends Event {
  * An event that is emitted when receiving UnfreezeFrame message from UE and video playback is about to be resumed.
  */
 export class HideFreezeFrameEvent extends Event {
-    readonly type: 'hideFreezeFrame';
+    override readonly type: 'hideFreezeFrame';
     constructor() {
         super('hideFreezeFrame');
     }
@@ -322,7 +322,7 @@ export class HideFreezeFrameEvent extends Event {
  * An event that is emitted when receiving WebRTC statistics.
  */
 export class StatsReceivedEvent extends Event {
-    readonly type: 'statsReceived';
+    override readonly type: 'statsReceived';
     readonly data: {
         /** Statistics object */
         aggregatedStats: AggregatedStats;
@@ -337,7 +337,7 @@ export class StatsReceivedEvent extends Event {
  * An event that is emitted when streamer list changes.
  */
 export class StreamerListMessageEvent extends Event {
-    readonly type: 'streamerListMessage';
+    override readonly type: 'streamerListMessage';
     readonly data: {
         /** Streamer list message containing an array of streamer ids */
         messageStreamerList: Messages.streamerList;
@@ -356,7 +356,7 @@ export class StreamerListMessageEvent extends Event {
  * An event that is emitted when a subscribed to streamer's id changes.
  */
 export class StreamerIDChangedMessageEvent extends Event {
-    readonly type: 'streamerIDChangedMessage';
+    override readonly type: 'streamerIDChangedMessage';
     readonly data: {
         /** The new ID of the streamer. */
         newID: string;
@@ -371,7 +371,7 @@ export class StreamerIDChangedMessageEvent extends Event {
  * An event that is emitted when receiving latency test results.
  */
 export class LatencyTestResultEvent extends Event {
-    readonly type: 'latencyTestResult';
+    override readonly type: 'latencyTestResult';
     readonly data: {
         /** Latency test result object */
         latencyTimings: LatencyTestResults;
@@ -387,7 +387,7 @@ export class LatencyTestResultEvent extends Event {
  * This event is handled by DataChannelLatencyTestController
  */
 export class DataChannelLatencyTestResponseEvent extends Event {
-    readonly type: 'dataChannelLatencyTestResponse';
+    override readonly type: 'dataChannelLatencyTestResponse';
     readonly data: {
         /** Latency test result object */
         response: DataChannelLatencyTestResponse;
@@ -402,7 +402,7 @@ export class DataChannelLatencyTestResponseEvent extends Event {
  * An event that is emitted when data channel latency test results are ready.
  */
 export class DataChannelLatencyTestResultEvent extends Event {
-    readonly type: 'dataChannelLatencyTestResult';
+    override readonly type: 'dataChannelLatencyTestResult';
     readonly data: {
         /** Latency test result object */
         result: DataChannelLatencyTestResult;
@@ -417,7 +417,7 @@ export class DataChannelLatencyTestResultEvent extends Event {
  * An event that is emitted when receiving initial settings from UE.
  */
 export class InitialSettingsEvent extends Event {
-    readonly type: 'initialSettings';
+    override readonly type: 'initialSettings';
     readonly data: {
         /** Initial settings from UE */
         settings: InitialSettings;
@@ -470,7 +470,7 @@ export type SettingsData =
  * An event that is emitted when PixelStreaming settings change.
  */
 export class SettingsChangedEvent extends Event {
-    readonly type: 'settingsChanged';
+    override readonly type: 'settingsChanged';
     readonly data: SettingsData;
     constructor(data: SettingsChangedEvent['data']) {
         super('settingsChanged');
@@ -482,7 +482,7 @@ export class SettingsChangedEvent extends Event {
  * Event emitted when an XR Session starts
  */
 export class XrSessionStartedEvent extends Event {
-    readonly type: 'xrSessionStarted';
+    override readonly type: 'xrSessionStarted';
     constructor() {
         super('xrSessionStarted');
     }
@@ -492,7 +492,7 @@ export class XrSessionStartedEvent extends Event {
  * Event emitted when an XR Session ends
  */
 export class XrSessionEndedEvent extends Event {
-    readonly type: 'xrSessionEnded';
+    override readonly type: 'xrSessionEnded';
     constructor() {
         super('xrSessionEnded');
     }
@@ -509,7 +509,7 @@ export type XrFrameData = {
  * Event emitted when an XR Frame is complete
  */
 export class XrFrameEvent extends Event {
-    readonly type: 'xrFrame';
+    override readonly type: 'xrFrame';
     readonly data: XrFrameData;
     constructor(data: XrFrameEvent['data']) {
         super('xrFrame');
@@ -521,7 +521,7 @@ export class XrFrameEvent extends Event {
  * An event that is emitted when receiving a player count from the signalling server
  */
 export class PlayerCountEvent extends Event {
-    readonly type: 'playerCount';
+    override readonly type: 'playerCount';
     readonly data: {
         /** count object */
         count: number;
@@ -536,7 +536,7 @@ export class PlayerCountEvent extends Event {
  * An event that is emitted when the webRTC connections is relayed over TCP.
  */
 export class WebRtcTCPRelayDetectedEvent extends Event {
-    readonly type: 'webRtcTCPRelayDetected';
+    override readonly type: 'webRtcTCPRelayDetected';
     constructor() {
         super('webRtcTCPRelayDetected');
     }
@@ -587,7 +587,7 @@ export class PixelStreamingEventEmitter extends EventTarget {
      * @param e event
      * @returns
      */
-    public dispatchEvent(e: PixelStreamingEvent): boolean {
+    public override dispatchEvent(e: PixelStreamingEvent): boolean {
         return super.dispatchEvent(e);
     }
 
@@ -596,7 +596,7 @@ export class PixelStreamingEventEmitter extends EventTarget {
      * @param type event name
      * @param listener event handler function
      */
-    public addEventListener<
+    public override addEventListener<
         T extends PixelStreamingEvent['type'],
         E extends PixelStreamingEvent & { type: T }
     >(type: T, listener: (e: Event & E) => void) {
@@ -608,7 +608,7 @@ export class PixelStreamingEventEmitter extends EventTarget {
      * @param type event name
      * @param listener event handler function
      */
-    public removeEventListener<
+    public override removeEventListener<
         T extends PixelStreamingEvent['type'],
         E extends PixelStreamingEvent & { type: T }
     >(type: T, listener: (e: Event & E) => void) {

package/src/VideoPlayer/VideoPlayer.ts

@@ -8,7 +8,7 @@ import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
  */
 declare global {
     interface HTMLElement {
-        mozRequestPointerLock?(): void;
+        mozRequestPointerLock(options: PointerLockOptions): Promise<void>;
     }
 }
 

package/src/WebRtcPlayer/WebRtcPlayerController.ts

@@ -88,6 +88,7 @@ export class WebRtcPlayerController {
     gamePadController: GamepadController;
     coordinateConverter: InputCoordTranslator;
     isUsingSFU: boolean;
+    isUsingSVC: boolean;
     isQualityController: boolean;
     statsTimerHandle: number;
     file: FileTemplate;
@@ -265,6 +266,7 @@ export class WebRtcPlayerController {
         );
 
         this.isUsingSFU = false;
+        this.isUsingSVC = false;
         this.isQualityController = false;
         this.preferredCodec = '';
         this.enableAutoReconnect = true;
@@ -285,6 +287,35 @@ export class WebRtcPlayerController {
             this.protocol.sendMessage(message);
         });
 
+        this.config._addOnOptionSettingChangedListener(
+            OptionParameters.PreferredQuality,
+            (preferredQuality) => {
+                if (preferredQuality === undefined || preferredQuality === '') {
+                    return;
+                }
+
+                let message;
+                if (this.isUsingSVC) {
+                    // User is using SVC so selected quality will be of the form SxTy(h). Just extract the x and y numbers
+                    message = MessageHelpers.createMessage(Messages.layerPreference, {
+                        spatialLayer: +preferredQuality[1] - 1,
+                        temporalLayer: +preferredQuality[3] - 1
+                    });
+                } else {
+                    // User is not using SVC so the selected quality will be either Low, Medium or High so we extract the appropriate spatial layer index
+                    const allQualities = this.config.getSettingOption(
+                        OptionParameters.PreferredQuality
+                    ).options;
+                    const qualityIndex = allQualities.indexOf(preferredQuality);
+                    message = MessageHelpers.createMessage(Messages.layerPreference, {
+                        spatialLayer: qualityIndex,
+                        temporalLayer: 0
+                    });
+                }
+                this.protocol.sendMessage(message);
+            }
+        );
+
         this.setVideoEncoderAvgQP(-1);
 
         this.signallingUrlBuilder = () => {
@@ -400,6 +431,13 @@ export class WebRtcPlayerController {
             'GamepadResponse',
             (data: ArrayBuffer) => this.onGamepadResponse(data)
         );
+        this.streamMessageController.registerMessageHandler(
+            MessageDirection.FromStreamer,
+            'Multiplexed',
+            () => {
+                /* Do nothing as this message type is used only by the SFU */
+            }
+        );
         this.streamMessageController.registerMessageHandler(
             MessageDirection.FromStreamer,
             'Protocol',
@@ -627,6 +665,20 @@ export class WebRtcPlayerController {
             (data: Array<number | string>) =>
                 this.sendMessageController.sendMessageToStreamer('XRAnalog', data)
         );
+        this.streamMessageController.registerMessageHandler(
+            MessageDirection.ToStreamer,
+            'ChannelRelayStatus',
+            () => {
+                /* Do nothing as this message type is used only by the SFU */
+            }
+        );
+        this.streamMessageController.registerMessageHandler(
+            MessageDirection.ToStreamer,
+            'Multiplexed',
+            () => {
+                /* Do nothing as this message type is used only by the SFU */
+            }
+        );
     }
 
     /**
@@ -1230,11 +1282,40 @@ export class WebRtcPlayerController {
         Logger.Info(`Got offer sdp ${Offer.sdp}`);
 
         this.isUsingSFU = Offer.sfu ? Offer.sfu : false;
-        if (this.isUsingSFU) {
+        this.isUsingSVC = Offer.scalabilityMode ? Offer.scalabilityMode != 'L1T1' : false;
+        if (this.isUsingSFU || this.isUsingSVC) {
             // Disable negotiating with the sfu as the sfu only supports one codec at a time
             this.peerConnectionController.preferredCodec = '';
         }
 
+        // NOTE: These two settings configurations are done outside of an if(this.isUsingSFU) so that users
+        // can switch between a default and SFU stream and have the settings reconfigure appropriately
+
+        const scalabilityMode = Offer.scalabilityMode ? Offer.scalabilityMode : 'L1T1';
+        let availableQualities = ['Default'];
+        if (this.isUsingSFU) {
+            if (!this.isUsingSVC) {
+                // User is using an SFU without any temporal scalability. Just offer easily readable names
+                availableQualities = ['Low', 'Medium', 'High'];
+            } else {
+                // User is using SVC. Generate all available options.
+                availableQualities = [];
+                const maxSpatialLayers = +scalabilityMode[1];
+                const maxTemporalLayers = +scalabilityMode[3];
+                for (let s = 1; s <= maxSpatialLayers; s++) {
+                    for (let t = 1; t <= maxTemporalLayers; t++) {
+                        availableQualities.push(`S${s}T${t}`);
+                    }
+                }
+            }
+        }
+
+        // Update the possible video quality options
+        this.config.setOptionSettingOptions(OptionParameters.PreferredQuality, availableQualities);
+
+        // Update the selected video quality with the highest possible resolution
+        this.config.setOptionSettingValue(OptionParameters.PreferredQuality, availableQualities.slice(-1)[0]);
+
         const sdpOffer: RTCSessionDescriptionInit = {
             sdp: Offer.sdp,
             type: 'offer'
@@ -1487,6 +1568,44 @@ export class WebRtcPlayerController {
         }
     }
 
+    /**
+     * Send the MinQuality encoder setting to the UE Instance.
+     * @param minQuality - The lower bound for quality when encoding
+     * valid values are (0-100) where:
+     * 0 = Worst quality.
+     * 100 = Best quality.
+     */
+    sendEncoderMinQuality(minQuality: number) {
+        Logger.Info(`MinQuality=${minQuality}\n`);
+
+        if (minQuality != null) {
+            this.streamMessageController.toStreamerHandlers.get('Command')([
+                JSON.stringify({
+                    'Encoder.MinQuality': minQuality
+                })
+            ]);
+        }
+    }
+
+    /**
+     * Send the MaxQuality encoder setting to the UE Instance.
+     * @param maxQuality - The upper bound for quality when encoding
+     * valid values are (0-100) where:
+     * 0 = Worst quality.
+     * 100 = Best quality.
+     */
+    sendEncoderMaxQuality(maxQuality: number) {
+        Logger.Info(`MaxQuality=${maxQuality}\n`);
+
+        if (maxQuality != null) {
+            this.streamMessageController.toStreamerHandlers.get('Command')([
+                JSON.stringify({
+                    'Encoder.MaxQuality': maxQuality
+                })
+            ]);
+        }
+    }
+
     /**
      * Send the { WebRTC.MinBitrate: SomeNumber }} command to UE to set
      * the minimum bitrate that we allow WebRTC to use

package/src/WebXR/WebXRController.ts

@@ -4,7 +4,7 @@ import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
 import { WebRtcPlayerController } from '../WebRtcPlayer/WebRtcPlayerController';
 import { XRGamepadController } from '../Inputs/XRGamepadController';
 import { XrFrameEvent } from '../Util/EventEmitter';
-import { Flags } from '../pixelstreamingfrontend';
+import { Flags } from '../Config/Config';
 
 export class WebXRController {
     private xrSession: XRSession;

package/src/__test__/mockRTCRtpReceiver.ts

@@ -7,7 +7,7 @@ export const mockRTCRtpReceiverImpl = {
                 mimeType: "testMimeType",
                 sdpFmtpLine: "AV1"
             }
-        ] as RTCRtpCodecCapability[],
+        ] as RTCRtpCodec[],
         headerExtensions: [] as RTCRtpHeaderExtensionCapability[]
     })
 } as any as typeof global.RTCRtpReceiver;

package/src/__test__/mockWebSocket.ts

@@ -53,17 +53,17 @@ export class MockWebSocketImpl extends WebSocket {
         triggerFunctions.triggerRemoteClose = this.triggerRemoteClose.bind(this);
     }
 
-    get readyState() {
+    override get readyState() {
         return this._readyState;
     }
 
-    close(code?: number | undefined, reason?: string | undefined): void {
+    override close(code?: number | undefined, reason?: string | undefined): void {
         super.close(code, reason);
         this._readyState = this.CLOSED;
         this.triggerOnClose({ code, reason });
     }
 
-    send(data: string | Blob | ArrayBufferView | ArrayBufferLike): void {
+    override send(data: string | Blob | ArrayBufferView | ArrayBufferLike): void {
         spyFunctions.sendSpy?.(data);
     }
 

package/src/pixelstreamingfrontend.ts

@@ -13,7 +13,12 @@ export {
     NumericParametersIds,
     TextParametersIds,
     OptionParametersIds,
-    AllSettings
+    AllSettings,
+    OptionIds,
+    isFlagId,
+    isNumericId,
+    isOptionId,
+    isTextId
 } from './Config/Config';
 export { SettingBase } from './Config/SettingBase';
 export { SettingFlag } from './Config/SettingFlag';

package/tsconfig.esm.json

@@ -2,6 +2,7 @@
     "extends": "./tsconfig.json",
     "compilerOptions": {
         "outDir": "./dist/esm",
-        "module": "ES6"
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
     }
 }

package/tsconfig.json

@@ -4,9 +4,13 @@
         "noImplicitAny": true,
         "esModuleInterop": true,
         "target": "ES6",
-        "moduleResolution": "nodenext",
         "sourceMap": true,
-        "allowJs": true
+        "allowJs": true,
+        "forceConsistentCasingInFileNames": true,
+        "noImplicitOverride": true,
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitReturns": true,
+        "noPropertyAccessFromIndexSignature": true
     },
     "lib": ["ES6"],
     "include": ["./src/*.ts"],