@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.4.2 → 0.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5",
-    "version": "0.4.2",
+    "version": "0.4.4",
     "description": "Frontend library for Unreal Engine 5.5 Pixel Streaming",
     "main": "dist/commonjs/pixelstreamingfrontend.js",
     "module": "dist/esm/pixelstreamingfrontend.js",
@@ -15,22 +15,22 @@
         "spellcheck": "cspell \"{README.md,.github/*.md,src/**/*.ts}\""
     },
     "devDependencies": {
-        "@types/jest": "27.5.1",
+        "@types/jest": "^29.5.14",
         "@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",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
         "prettier": "3.3.3",
-        "ts-jest": "27.1.5",
-        "typedoc": "^0.23.24",
-        "typescript": "^4.9.4"
+        "ts-jest": "^29.2.5",
+        "typedoc": "^0.27.4",
+        "typescript": "^5.0.0"
     },
     "dependencies": {
+        "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "^0.1.4",
         "@types/webxr": "^0.5.1",
-        "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "^0.1.3",
         "sdp": "^3.1.0"
     },
     "repository": {

package/src/Config/Config.ts

@@ -38,7 +38,7 @@ export class Flags {
 export type FlagsKeys = Exclude<keyof typeof Flags, 'prototype'>;
 export type FlagsIds = (typeof Flags)[FlagsKeys];
 
-const isFlagId = (id: string): id is FlagsIds =>
+export const isFlagId = (id: string): id is FlagsIds =>
     Object.getOwnPropertyNames(Flags).some((name: FlagsKeys) => Flags[name] === id);
 
 /**
@@ -64,7 +64,7 @@ export class NumericParameters {
 export type NumericParametersKeys = Exclude<keyof typeof NumericParameters, 'prototype'>;
 export type NumericParametersIds = (typeof NumericParameters)[NumericParametersKeys];
 
-const isNumericId = (id: string): id is NumericParametersIds =>
+export const isNumericId = (id: string): id is NumericParametersIds =>
     Object.getOwnPropertyNames(NumericParameters).some(
         (name: NumericParametersKeys) => NumericParameters[name] === id
     );
@@ -80,7 +80,7 @@ export class TextParameters {
 export type TextParametersKeys = Exclude<keyof typeof TextParameters, 'prototype'>;
 export type TextParametersIds = (typeof TextParameters)[TextParametersKeys];
 
-const isTextId = (id: string): id is TextParametersIds =>
+export const isTextId = (id: string): id is TextParametersIds =>
     Object.getOwnPropertyNames(TextParameters).some(
         (name: TextParametersKeys) => TextParameters[name] === id
     );
@@ -92,12 +92,13 @@ const isTextId = (id: string): id is TextParametersIds =>
 export class OptionParameters {
     static PreferredCodec = 'PreferredCodec' as const;
     static StreamerId = 'StreamerId' as const;
+    static PreferredQuality = 'PreferredQuality' as const;
 }
 
 export type OptionParametersKeys = Exclude<keyof typeof OptionParameters, 'prototype'>;
 export type OptionParametersIds = (typeof OptionParameters)[OptionParametersKeys];
 
-const isOptionId = (id: string): id is OptionParametersIds =>
+export const isOptionId = (id: string): id is OptionParametersIds =>
     Object.getOwnPropertyNames(OptionParameters).some(
         (name: OptionParametersKeys) => OptionParameters[name] === id
     );
@@ -281,6 +282,20 @@ export class Config {
             )
         );
 
+        this.optionParameters.set(
+            OptionParameters.PreferredQuality,
+            new SettingOption(
+                OptionParameters.PreferredQuality,
+                'Preferred Quality',
+                'The preferred quality of the stream (only applicable when using the SFU)',
+                settings && Object.prototype.hasOwnProperty.call(settings, OptionParameters.PreferredQuality)
+                    ? settings[OptionParameters.PreferredQuality]!
+                    : 'Default',
+                ['Default'],
+                useUrlParams
+            )
+        );
+
         /**
          * Boolean parameters
          */

package/src/Config/SettingFlag.ts

@@ -7,8 +7,8 @@ import { SettingBase } from './SettingBase';
  * A boolean flag setting object with a text label.
  */
 export class SettingFlag<CustomIds extends string = FlagsIds> extends SettingBase {
-    id: FlagsIds | CustomIds;
-    onChangeEmit: (changedValue: boolean) => void;
+    override id: FlagsIds | CustomIds;
+    override onChangeEmit: (changedValue: boolean) => void;
 
     constructor(
         id: FlagsIds | CustomIds,
@@ -33,7 +33,7 @@ export class SettingFlag<CustomIds extends string = FlagsIds> extends SettingBas
         this.useUrlParams = useUrlParams;
     }
 
-    protected getValueAsString(): string {
+    protected override getValueAsString(): string {
         return this.flag ? 'true' : 'false';
     }
 

package/src/Config/SettingNumber.ts

@@ -10,8 +10,8 @@ export class SettingNumber<CustomIds extends string = NumericParametersIds> exte
     _min: number | null;
     _max: number | null;
 
-    id: NumericParametersIds | CustomIds;
-    onChangeEmit: (changedValue: number) => void;
+    override id: NumericParametersIds | CustomIds;
+    override onChangeEmit: (changedValue: number) => void;
 
     constructor(
         id: NumericParametersIds | CustomIds,
@@ -41,7 +41,7 @@ export class SettingNumber<CustomIds extends string = NumericParametersIds> exte
         this.useUrlParams = useUrlParams;
     }
 
-    protected getValueAsString(): string {
+    protected override getValueAsString(): string {
         return this.number.toString();
     }
 

package/src/Config/SettingOption.ts

@@ -8,8 +8,8 @@ import { SettingBase } from './SettingBase';
  * An Option setting object with a text label. Allows you to specify an array of options and select one of them.
  */
 export class SettingOption<CustomIds extends string = OptionParametersIds> extends SettingBase {
-    id: OptionParametersIds | CustomIds;
-    onChangeEmit: (changedValue: string) => void;
+    override id: OptionParametersIds | CustomIds;
+    override onChangeEmit: (changedValue: string) => void;
     _options: Array<string>;
 
     /* Transforms the url parameter value into something else, by default no transformation is made, the url param is returned as-is. */
@@ -45,7 +45,7 @@ export class SettingOption<CustomIds extends string = OptionParametersIds> exten
         this.useUrlParams = useUrlParams;
     }
 
-    protected getValueAsString(): string {
+    protected override getValueAsString(): string {
         return this.selected;
     }
 

package/src/Config/SettingText.ts

@@ -7,9 +7,9 @@ import { SettingBase } from './SettingBase';
  * A text setting object with a text label.
  */
 export class SettingText<CustomIds extends string = TextParametersIds> extends SettingBase {
-    id: TextParametersIds | CustomIds;
-    onChangeEmit: (changedValue: string) => void;
-    useUrlParams: boolean;
+    override id: TextParametersIds | CustomIds;
+    override onChangeEmit: (changedValue: string) => void;
+    override useUrlParams: boolean;
 
     constructor(
         id: TextParametersIds | CustomIds,
@@ -33,7 +33,7 @@ export class SettingText<CustomIds extends string = TextParametersIds> extends S
         this.useUrlParams = useUrlParams;
     }
 
-    protected getValueAsString(): string {
+    protected override getValueAsString(): string {
         return this.text;
     }
 

package/src/DataChannel/DataChannelController.ts

@@ -49,7 +49,7 @@ export class DataChannelController {
         this.dataChannel.onopen = (ev: Event) => this.handleOnOpen(ev);
         this.dataChannel.onclose = (ev: Event) => this.handleOnClose(ev);
         this.dataChannel.onmessage = (ev: MessageEvent) => this.handleOnMessage(ev);
-        this.dataChannel.onerror = (ev: MessageEvent) => this.handleOnError(ev);
+        this.dataChannel.onerror = (ev: Event) => this.handleOnError(ev);
     }
 
     /**
@@ -81,7 +81,7 @@ export class DataChannelController {
      * Handles when an error is thrown
      * @param event - Error Event
      */
-    handleOnError(event: MessageEvent) {
+    handleOnError(event: Event) {
         Logger.Info(`Data Channel (${this.label}) error: ${event}`);
         this.onError(this.dataChannel?.label, event);
     }

package/src/Inputs/MouseControllerHovering.ts

@@ -33,7 +33,7 @@ export class MouseControllerHovering extends MouseController {
         this.onContextMenuListener = this.onContextMenu.bind(this);
     }
 
-    register(): void {
+    override register(): void {
         super.register();
 
         this.videoElementParent.addEventListener('mousemove', this.onMouseMoveListener);
@@ -44,7 +44,7 @@ export class MouseControllerHovering extends MouseController {
         this.videoElementParent.addEventListener('dblclick', this.onMouseDblClickListener);
     }
 
-    unregister(): void {
+    override unregister(): void {
         this.videoElementParent.removeEventListener('mousemove', this.onMouseMoveListener);
         this.videoElementParent.removeEventListener('mousedown', this.onMouseDownListener);
         this.videoElementParent.removeEventListener('mouseup', this.onMouseUpListener);

package/src/Inputs/MouseControllerLocked.ts

@@ -44,7 +44,7 @@ export class MouseControllerLocked extends MouseController {
         this.onMouseMoveListener = this.onMouseMove.bind(this);
     }
 
-    register() {
+    override register() {
         super.register();
 
         this.videoElementParent.requestPointerLock =
@@ -64,7 +64,7 @@ export class MouseControllerLocked extends MouseController {
         this.videoElementParent.addEventListener('dblclick', this.onMouseDblClickListener);
     }
 
-    unregister() {
+    override unregister() {
         const pointerLockElement = document.pointerLockElement || document.mozPointerLockElement;
         if (document.exitPointerLock && pointerLockElement === this.videoElementParent) {
             document.exitPointerLock();

package/src/PeerConnectionController/PeerConnectionController.ts

@@ -428,18 +428,18 @@ export class PeerConnectionController {
                 ) {
                     // Get our preferred codec from the codecs options drop down
                     const preferredRTPCodec = this.preferredCodec.split(' ');
-                    const preferredRTCRtpCodecCapability: RTCRtpCodecCapability = {
+                    const preferredRTCRtpCodecCapability: RTCRtpCodec = {
                         mimeType: 'video/' + preferredRTPCodec[0] /* Name */,
                         clockRate: 90000 /* All current video formats in browsers have 90khz clock rate */,
                         sdpFmtpLine: preferredRTPCodec[1] ? preferredRTPCodec[1] : ''
                     };
 
                     // Populate a list of codecs we will support with our preferred one in the first position
-                    const ourSupportedCodecs: Array<RTCRtpCodecCapability> = [preferredRTCRtpCodecCapability];
+                    const ourSupportedCodecs: Array<RTCRtpCodec> = [preferredRTCRtpCodecCapability];
 
                     // Go through all codecs the browser supports and add them to the list (in any order)
                     RTCRtpReceiver.getCapabilities('video').codecs.forEach(
-                        (browserSupportedCodec: RTCRtpCodecCapability) => {
+                        (browserSupportedCodec: RTCRtpCodec) => {
                             // Don't add our preferred codec again, but add everything else
                             if (browserSupportedCodec.mimeType != preferredRTCRtpCodecCapability.mimeType) {
                                 ourSupportedCodecs.push(browserSupportedCodec);
@@ -626,11 +626,11 @@ export class PeerConnectionController {
         const sections = splitSections(rtcSessionDescription.sdp);
         // discard the session information as we only want media related info
         sections.shift();
-        sections.forEach((mediaSection) => {
+        sections.forEach((mediaSection: any) => {
             const { codecs } = parseRtpParameters(mediaSection);
             // Filter only for VPX / H26X / AV1
             const matcher = /(VP\d|H26\d|AV1).*/;
-            codecs.forEach((c) => {
+            codecs.forEach((c: any) => {
                 const str =
                     c.name +
                     ' ' +

package/src/UeInstanceMessage/SendMessageController.ts

@@ -50,6 +50,7 @@ export class SendMessageController {
                             case 'int16':
                             case 'float':
                             case 'double':
+                            default:
                                 return 'number';
                             case 'string':
                                 return 'string';

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>;
     }
 }