@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.1.3 → 0.2.1

package/src/WebXR/WebXRController.ts

@@ -3,14 +3,14 @@
 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 { XrFrameEvent } from '../Util/EventEmitter';
 import { Flags } from '../pixelstreamingfrontend';
 
 export class WebXRController {
     private xrSession: XRSession;
     private xrRefSpace: XRReferenceSpace;
     private gl: WebGL2RenderingContext;
-    private xrViewerPose : XRViewerPose = null;
+    private xrViewerPose: XRViewerPose = null;
     // Used for comparisons to ensure two numbers are close enough.
     private EPSILON = 0.0000001;
 
@@ -43,9 +43,7 @@ export class WebXRController {
     constructor(webRtcPlayerController: WebRtcPlayerController) {
         this.xrSession = null;
         this.webRtcController = webRtcPlayerController;
-        this.xrGamepadController = new XRGamepadController(
-            this.webRtcController.streamMessageController
-        );
+        this.xrGamepadController = new XRGamepadController(this.webRtcController.streamMessageController);
         this.onSessionEnded = new EventTarget();
         this.onSessionStarted = new EventTarget();
         this.onFrame = new EventTarget();
@@ -53,9 +51,8 @@ export class WebXRController {
 
     public xrClicked() {
         if (!this.xrSession) {
-
-            if(!navigator.xr){
-                Logger.Error(Logger.GetStackTrace(), "This browser does not support XR.");
+            if (!navigator.xr) {
+                Logger.Error('This browser does not support XR.');
                 return;
             }
 
@@ -71,13 +68,15 @@ export class WebXRController {
     }
 
     onXrSessionEnded() {
-        Logger.Log(Logger.GetStackTrace(), 'XR Session ended');
+        Logger.Info('XR Session ended');
         this.xrSession = null;
         this.onSessionEnded.dispatchEvent(new Event('xrSessionEnded'));
     }
 
     initGL() {
-        if (this.gl) { return; }
+        if (this.gl) {
+            return;
+        }
         const canvas = document.createElement('canvas');
         this.gl = canvas.getContext('webgl2', {
             xrCompatible: true
@@ -88,10 +87,8 @@ export class WebXRController {
     }
 
     initShaders() {
-
         // shader source code
-        const vertexShaderSource: string =
-        `
+        const vertexShaderSource: string = `
         attribute vec2 a_position;
         attribute vec2 a_texCoord;
 
@@ -106,8 +103,7 @@ export class WebXRController {
         }
         `;
 
-        const fragmentShaderSource: string =
-        `
+        const fragmentShaderSource: string = `
         precision mediump float;
 
         // our texture
@@ -139,51 +135,28 @@ export class WebXRController {
         this.gl.useProgram(shaderProgram);
 
         // look up where vertex data needs to go
-        this.positionLocation = this.gl.getAttribLocation(
-            shaderProgram,
-            'a_position'
-        );
-        this.texcoordLocation = this.gl.getAttribLocation(
-            shaderProgram,
-            'a_texCoord'
-        );
+        this.positionLocation = this.gl.getAttribLocation(shaderProgram, 'a_position');
+        this.texcoordLocation = this.gl.getAttribLocation(shaderProgram, 'a_texCoord');
     }
 
-    updateVideoTexture(){
-
-        if(!this.videoTexture){
+    updateVideoTexture() {
+        if (!this.videoTexture) {
             // Create our texture that we use in our shader
             // and bind it once because we never use any other texture.
             this.videoTexture = this.gl.createTexture();
             this.gl.bindTexture(this.gl.TEXTURE_2D, this.videoTexture);
 
             // Set the parameters so we can render any size image.
-            this.gl.texParameteri(
-                this.gl.TEXTURE_2D,
-                this.gl.TEXTURE_WRAP_S,
-                this.gl.CLAMP_TO_EDGE
-            );
-            this.gl.texParameteri(
-                this.gl.TEXTURE_2D,
-                this.gl.TEXTURE_WRAP_T,
-                this.gl.CLAMP_TO_EDGE
-            );
-            this.gl.texParameteri(
-                this.gl.TEXTURE_2D,
-                this.gl.TEXTURE_MIN_FILTER,
-                this.gl.LINEAR
-            );
-            this.gl.texParameteri(
-                this.gl.TEXTURE_2D,
-                this.gl.TEXTURE_MAG_FILTER,
-                this.gl.LINEAR
-            );
+            this.gl.texParameteri(this.gl.TEXTURE_2D, this.gl.TEXTURE_WRAP_S, this.gl.CLAMP_TO_EDGE);
+            this.gl.texParameteri(this.gl.TEXTURE_2D, this.gl.TEXTURE_WRAP_T, this.gl.CLAMP_TO_EDGE);
+            this.gl.texParameteri(this.gl.TEXTURE_2D, this.gl.TEXTURE_MIN_FILTER, this.gl.LINEAR);
+            this.gl.texParameteri(this.gl.TEXTURE_2D, this.gl.TEXTURE_MAG_FILTER, this.gl.LINEAR);
         }
 
         const videoHeight = this.webRtcController.videoPlayer.getVideoElement().videoHeight;
         const videoWidth = this.webRtcController.videoPlayer.getVideoElement().videoWidth;
 
-        if(this.prevVideoHeight != videoHeight || this.prevVideoWidth != videoWidth){
+        if (this.prevVideoHeight != videoHeight || this.prevVideoWidth != videoWidth) {
             // Do full update of texture if dimensions do not match
             this.gl.texImage2D(
                 this.gl.TEXTURE_2D,
@@ -216,7 +189,7 @@ export class WebXRController {
         this.prevVideoWidth = videoWidth;
     }
 
-    initBuffers(){
+    initBuffers() {
         // Create out position buffer and its vertex shader attribute
         {
             // Create a buffer to put the the vertices of the plane we will draw the video stream onto
@@ -263,14 +236,7 @@ export class WebXRController {
             // The texture coordinates to apply for rectangle we are drawing
             this.gl.bufferData(
                 this.gl.ARRAY_BUFFER,
-                new Float32Array([
-                    0.0, 0.0,
-                    1.0, 0.0,
-                    0.0, 1.0,
-                    0.0, 1.0,
-                    1.0, 0.0,
-                    1.0, 1.0
-                ]),
+                new Float32Array([0.0, 0.0, 1.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 0.0, 1.0, 1.0]),
                 this.gl.STATIC_DRAW
             );
 
@@ -287,7 +253,7 @@ export class WebXRController {
     }
 
     onXrSessionStarted(session: XRSession) {
-        Logger.Log(Logger.GetStackTrace(), 'XR Session started');
+        Logger.Info('XR Session started');
 
         this.xrSession = session;
         this.xrSession.addEventListener('end', () => {
@@ -308,9 +274,9 @@ export class WebXRController {
             });
 
             // Update target framerate to 90 fps if 90 fps is supported in this XR device
-            if(this.xrSession.supportedFrameRates) {
+            if (this.xrSession.supportedFrameRates) {
                 for (const frameRate of this.xrSession.supportedFrameRates) {
-                    if(frameRate == 90){
+                    if (frameRate == 90) {
                         session.updateTargetFrameRate(90);
                     }
                 }
@@ -323,16 +289,22 @@ export class WebXRController {
         this.onSessionStarted.dispatchEvent(new Event('xrSessionStarted'));
     }
 
-    areArraysEqual(a: Float32Array, b: Float32Array) : boolean {
-        return a.length === b.length && a.every((element, index) => Math.abs(element - b[index]) <= this.EPSILON);
+    areArraysEqual(a: Float32Array, b: Float32Array): boolean {
+        return (
+            a.length === b.length && a.every((element, index) => Math.abs(element - b[index]) <= this.EPSILON)
+        );
     }
 
-    arePointsEqual(a: DOMPointReadOnly, b: DOMPointReadOnly) : boolean {
-        return Math.abs(a.x - b.x) >= this.EPSILON && Math.abs(a.y - b.y) >= this.EPSILON && Math.abs(a.z - b.z) >= this.EPSILON;
+    arePointsEqual(a: DOMPointReadOnly, b: DOMPointReadOnly): boolean {
+        return (
+            Math.abs(a.x - b.x) >= this.EPSILON &&
+            Math.abs(a.y - b.y) >= this.EPSILON &&
+            Math.abs(a.z - b.z) >= this.EPSILON
+        );
     }
 
     sendXRDataToUE() {
-        if(this.leftView == null || this.rightView == null) {
+        if (this.leftView == null || this.rightView == null) {
             return;
         }
 
@@ -341,10 +313,11 @@ export class WebXRController {
         // the `XREyeViews` is a much larger message and changes infrequently (e.g. only when user changes headset IPD).
         // Therefore, we only need to send it once on startup and then any time it changes.
         // The rest of the time we can send the `XRHMDTransform` message.
-        let shouldSendEyeViews = this.lastSentLeftEyeProj == null ||
-                                 this.lastSentRightEyeProj == null ||
-                                 this.lastSentRelativeLeftEyePos == null ||
-                                 this.lastSentRelativeRightEyePos == null;
+        let shouldSendEyeViews =
+            this.lastSentLeftEyeProj == null ||
+            this.lastSentRightEyeProj == null ||
+            this.lastSentRelativeLeftEyePos == null ||
+            this.lastSentRelativeRightEyePos == null;
 
         const leftEyeTrans = this.leftView.transform.matrix;
         const leftEyeProj = this.leftView.projectionMatrix;
@@ -353,7 +326,7 @@ export class WebXRController {
         const hmdTrans = this.xrViewerPose.transform.matrix;
 
         // Check if projection matrices have changed
-        if(!shouldSendEyeViews && this.lastSentLeftEyeProj != null && this.lastSentRightEyeProj != null) {
+        if (!shouldSendEyeViews && this.lastSentLeftEyeProj != null && this.lastSentRightEyeProj != null) {
             const leftEyeProjUnchanged = this.areArraysEqual(leftEyeProj, this.lastSentLeftEyeProj);
             const rightEyeProjUnchanged = this.areArraysEqual(rightEyeProj, this.lastSentRightEyeProj);
             shouldSendEyeViews = leftEyeProjUnchanged == false || rightEyeProjUnchanged == false;
@@ -374,14 +347,24 @@ export class WebXRController {
         );
 
         // Check if relative eye pos has changed (e.g IPD changed)
-        if(!shouldSendEyeViews && this.lastSentRelativeLeftEyePos != null && this.lastSentRelativeRightEyePos != null) {
-            const leftEyePosUnchanged = this.arePointsEqual(leftEyeRelativePos, this.lastSentRelativeLeftEyePos);
-            const rightEyePosUnchanged = this.arePointsEqual(rightEyeRelativePos, this.lastSentRelativeRightEyePos);
+        if (
+            !shouldSendEyeViews &&
+            this.lastSentRelativeLeftEyePos != null &&
+            this.lastSentRelativeRightEyePos != null
+        ) {
+            const leftEyePosUnchanged = this.arePointsEqual(
+                leftEyeRelativePos,
+                this.lastSentRelativeLeftEyePos
+            );
+            const rightEyePosUnchanged = this.arePointsEqual(
+                rightEyeRelativePos,
+                this.lastSentRelativeRightEyePos
+            );
             shouldSendEyeViews = leftEyePosUnchanged == false || rightEyePosUnchanged == false;
             // Note: We are not checking if EyeView rotation changes (as far as I know no HMD supports changing this value at runtime).
         }
 
-        if(shouldSendEyeViews) {
+        if (shouldSendEyeViews) {
             // send transform (4x4) and projection matrix (4x4) data for each eye (left first, then right)
             // prettier-ignore
             this.webRtcController.streamMessageController.toStreamerHandlers.get('XREyeViews')([
@@ -415,15 +398,26 @@ export class WebXRController {
             this.lastSentRightEyeProj = rightEyeProj;
             this.lastSentRelativeLeftEyePos = leftEyeRelativePos;
             this.lastSentRelativeRightEyePos = rightEyeRelativePos;
-        }
-        else {
+        } else {
             // If we don't need to the entire eye views being sent just send the HMD transform
             this.webRtcController.streamMessageController.toStreamerHandlers.get('XRHMDTransform')([
                 // HMD 4x4 transform
-                hmdTrans[0], hmdTrans[4], hmdTrans[8],  hmdTrans[12],
-                hmdTrans[1], hmdTrans[5], hmdTrans[9],  hmdTrans[13],
-                hmdTrans[2], hmdTrans[6], hmdTrans[10], hmdTrans[14],
-                hmdTrans[3], hmdTrans[7], hmdTrans[11], hmdTrans[15],
+                hmdTrans[0],
+                hmdTrans[4],
+                hmdTrans[8],
+                hmdTrans[12],
+                hmdTrans[1],
+                hmdTrans[5],
+                hmdTrans[9],
+                hmdTrans[13],
+                hmdTrans[2],
+                hmdTrans[6],
+                hmdTrans[10],
+                hmdTrans[14],
+                hmdTrans[3],
+                hmdTrans[7],
+                hmdTrans[11],
+                hmdTrans[15]
             ]);
         }
     }
@@ -432,7 +426,7 @@ export class WebXRController {
         this.xrViewerPose = frame.getViewerPose(this.xrRefSpace);
         if (this.xrViewerPose) {
             this.updateViews();
-            if(this.leftView == null || this.rightView == null) {
+            if (this.leftView == null || this.rightView == null) {
                 return;
             }
 
@@ -444,33 +438,27 @@ export class WebXRController {
         if (this.webRtcController.config.isFlagEnabled(Flags.XRControllerInput)) {
             this.xrSession.inputSources.forEach(
                 (source: XRInputSource, _index: number, _array: XRInputSource[]) => {
-                    this.xrGamepadController.updateStatus(
-                        source,
-                        frame,
-                        this.xrRefSpace
-                    );
+                    this.xrGamepadController.updateStatus(source, frame, this.xrRefSpace);
                 },
                 this
             );
         }
 
-        this.xrSession.requestAnimationFrame(
-            (time: DOMHighResTimeStamp, frame: XRFrame) =>
-                this.onXrFrame(time, frame)
+        this.xrSession.requestAnimationFrame((time: DOMHighResTimeStamp, frame: XRFrame) =>
+            this.onXrFrame(time, frame)
         );
 
         this.onFrame.dispatchEvent(new XrFrameEvent({ time, frame }));
     }
 
     private updateViews() {
-        if(!this.xrViewerPose) {
+        if (!this.xrViewerPose) {
             return;
         }
         for (const view of this.xrViewerPose.views) {
-            if (view.eye === "left") {
+            if (view.eye === 'left') {
                 this.leftView = view;
-            }
-            else if(view.eye === "right") {
+            } else if (view.eye === 'right') {
                 this.rightView = view;
             }
         }
@@ -493,8 +481,8 @@ export class WebXRController {
     }
 
     static isSessionSupported(mode: XRSessionMode): Promise<boolean> {
-        if (location.protocol !== "https:") {
-            Logger.Info(null, "WebXR requires https, if you want WebXR use https.");
+        if (location.protocol !== 'https:') {
+            Logger.Info('WebXR requires https, if you want WebXR use https.');
         }
 
         if (navigator.xr) {

package/src/pixelstreamingfrontend.ts

@@ -25,22 +25,18 @@ export { PixelStreaming } from './PixelStreaming/PixelStreaming';
 export { AFKController as AfkLogic } from './AFK/AFKController';
 
 export { LatencyTestResults } from './DataChannel/LatencyTestResults';
-export {
-    EncoderSettings,
-    InitialSettings,
-    WebRTCSettings
-} from './DataChannel/InitialSettings';
+export { EncoderSettings, InitialSettings, WebRTCSettings } from './DataChannel/InitialSettings';
 export { AggregatedStats } from './PeerConnectionController/AggregatedStats';
-export { UnquantizedDenormalizedUnsignedCoord as UnquantizedAndDenormalizeUnsigned } from './Util/CoordinateConverter';
+export {
+    InputCoordTranslator,
+    UntranslatedCoordUnsigned as UnquantizedAndDenormalizeUnsigned
+} from './Util/InputCoordTranslator';
 export { MessageDirection } from './UeInstanceMessage/StreamMessageController';
 
 export { CandidatePairStats } from './PeerConnectionController/CandidatePairStats';
 export { CandidateStat } from './PeerConnectionController/CandidateStat';
 export { DataChannelStats } from './PeerConnectionController/DataChannelStats';
-export {
-    InboundAudioStats,
-    InboundVideoStats
-} from './PeerConnectionController/InboundRTPStats';
+export { InboundAudioStats, InboundVideoStats } from './PeerConnectionController/InboundRTPStats';
 export { OutBoundVideoStats } from './PeerConnectionController/OutBoundRTPStats';
 export * from './Util/EventEmitter';
 export * from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';

package/types/AFK/AFKController.d.ts

@@ -1,7 +1,6 @@
 import { Config } from '../Config/Config';
 import { PixelStreaming } from '../PixelStreaming/PixelStreaming';
 export declare class AFKController {
-    closeTimeout: number;
     active: boolean;
     countdownActive: boolean;
     warnTimer: ReturnType<typeof setTimeout>;

package/types/Config/Config.d.ts

@@ -11,7 +11,6 @@ export declare class Flags {
     static AutoConnect: "AutoConnect";
     static AutoPlayVideo: "AutoPlayVideo";
     static AFKDetection: "TimeoutIfIdle";
-    static BrowserSendOffer: "OfferToReceive";
     static HoveringMouseMode: "HoveringMouse";
     static ForceMonoAudio: "ForceMonoAudio";
     static ForceTURN: "ForceTURN";
@@ -21,6 +20,7 @@ export declare class Flags {
     static StartVideoMuted: "StartVideoMuted";
     static SuppressBrowserKeys: "SuppressBrowserKeys";
     static UseMic: "UseMic";
+    static UseCamera: "UseCamera";
     static KeyboardInput: "KeyboardInput";
     static MouseInput: "MouseInput";
     static TouchInput: "TouchInput";
@@ -30,13 +30,14 @@ export declare class Flags {
     static HideUI: "HideUI";
 }
 export type FlagsKeys = Exclude<keyof typeof Flags, 'prototype'>;
-export type FlagsIds = typeof Flags[FlagsKeys];
+export type FlagsIds = (typeof Flags)[FlagsKeys];
 /**
  * A collection of numeric parameters that are core to all Pixel Streaming experiences.
  *
  */
 export declare class NumericParameters {
     static AFKTimeoutSecs: "AFKTimeout";
+    static AFKCountdownSecs: "AFKCountdown";
     static MinQP: "MinQP";
     static MaxQP: "MaxQP";
     static WebRTCFPS: "WebRTCFPS";
@@ -46,7 +47,7 @@ export declare class NumericParameters {
     static StreamerAutoJoinInterval: "StreamerAutoJoinInterval";
 }
 export type NumericParametersKeys = Exclude<keyof typeof NumericParameters, 'prototype'>;
-export type NumericParametersIds = typeof NumericParameters[NumericParametersKeys];
+export type NumericParametersIds = (typeof NumericParameters)[NumericParametersKeys];
 /**
  * A collection of textual parameters that are core to all Pixel Streaming experiences.
  *
@@ -55,7 +56,7 @@ export declare class TextParameters {
     static SignallingServerUrl: "ss";
 }
 export type TextParametersKeys = Exclude<keyof typeof TextParameters, 'prototype'>;
-export type TextParametersIds = typeof TextParameters[TextParametersKeys];
+export type TextParametersIds = (typeof TextParameters)[TextParametersKeys];
 /**
  * A collection of enum based parameters that are core to all Pixel Streaming experiences.
  *
@@ -65,7 +66,7 @@ export declare class OptionParameters {
     static StreamerId: "StreamerId";
 }
 export type OptionParametersKeys = Exclude<keyof typeof OptionParameters, 'prototype'>;
-export type OptionParametersIds = typeof OptionParameters[OptionParametersKeys];
+export type OptionParametersIds = (typeof OptionParameters)[OptionParametersKeys];
 /**
  * Utility types for inferring data type based on setting ID
  */

package/types/Config/SettingBase.d.ts

@@ -4,6 +4,8 @@
 export declare class SettingBase {
     id: string;
     description: string;
+    useUrlParams: boolean;
+    _urlParams: Record<string, string>;
     _label: string;
     _value: unknown;
     onChange: (changedValue: unknown, setting: SettingBase) => void;
@@ -27,4 +29,15 @@ export declare class SettingBase {
      * @param inValue The new value for the setting.
      */
     set value(inValue: unknown);
+    /**
+     * Persist the setting value in URL.
+     */
+    updateURLParams(): void;
+    /**
+     * Allows sub types to provide their value for the url search params.
+     */
+    protected getValueAsString(): string;
+    private parseURLParams;
+    protected hasURLParam(name: string): boolean;
+    protected getURLParam(name: string): string;
 }

package/types/Config/SettingFlag.d.ts

@@ -6,17 +6,8 @@ import { SettingBase } from './SettingBase';
 export declare class SettingFlag<CustomIds extends string = FlagsIds> extends SettingBase {
     id: FlagsIds | CustomIds;
     onChangeEmit: (changedValue: boolean) => void;
-    useUrlParams: boolean;
     constructor(id: FlagsIds | CustomIds, label: string, description: string, defaultFlagValue: boolean, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
-    /**
-     * Parse the flag value from the url parameters.
-     * @returns True if the url parameters contains /?id, but False if /?id=false
-     */
-    getUrlParamFlag(): boolean;
-    /**
-     * Persist the setting value in URL.
-     */
-    updateURLParams(): void;
+    protected getValueAsString(): string;
     /**
      * Enables this flag.
      */

package/types/Config/SettingNumber.d.ts

@@ -8,12 +8,8 @@ export declare class SettingNumber<CustomIds extends string = NumericParametersI
     _max: number;
     id: NumericParametersIds | CustomIds;
     onChangeEmit: (changedValue: number) => void;
-    useUrlParams: boolean;
     constructor(id: NumericParametersIds | CustomIds, label: string, description: string, min: number, max: number, defaultNumber: number, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
-    /**
-     * Persist the setting value in URL.
-     */
-    updateURLParams(): void;
+    protected getValueAsString(): string;
     /**
      * Set the number value (will be clamped within range).
      */

package/types/Config/SettingOption.d.ts

@@ -7,17 +7,8 @@ export declare class SettingOption<CustomIds extends string = OptionParametersId
     id: OptionParametersIds | CustomIds;
     onChangeEmit: (changedValue: string) => void;
     _options: Array<string>;
-    useUrlParams: boolean;
     constructor(id: OptionParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, options: Array<string>, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
-    /**
-     * Parse the text value from the url parameters.
-     * @returns The text value parsed from the url if the url parameters contains /?id=value, but empty string if just /?id or no url param found.
-     */
-    getUrlParamText(): string;
-    /**
-     * Persist the setting value in URL.
-     */
-    updateURLParams(): void;
+    protected getValueAsString(): string;
     /**
      * Add a change listener to the select element.
      */

package/types/Config/SettingText.d.ts

@@ -8,15 +8,7 @@ export declare class SettingText<CustomIds extends string = TextParametersIds> e
     onChangeEmit: (changedValue: string) => void;
     useUrlParams: boolean;
     constructor(id: TextParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
-    /**
-     * Parse the text value from the url parameters.
-     * @returns The text value parsed from the url if the url parameters contains /?id=value, but empty string if just /?id or no url param found.
-     */
-    getUrlParamText(): string;
-    /**
-     * Persist the setting value in URL.
-     */
-    updateURLParams(): void;
+    protected getValueAsString(): string;
     /**
      * @return The setting's value.
      */

package/types/DataChannel/DataChannelLatencyTestController.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { DataChannelLatencyTestRecord, DataChannelLatencyTestRequest, DataChannelLatencyTestResponse, DataChannelLatencyTestResult, DataChannelLatencyTestSeq, DataChannelLatencyTestTimestamp } from "./DataChannelLatencyTestResults";
+import { DataChannelLatencyTestRecord, DataChannelLatencyTestRequest, DataChannelLatencyTestResponse, DataChannelLatencyTestResult, DataChannelLatencyTestSeq, DataChannelLatencyTestTimestamp } from './DataChannelLatencyTestResults';
 export type DataChannelLatencyTestConfig = {
     duration: number;
     rps: number;

package/types/Inputs/GamepadController.d.ts

@@ -1,50 +1,6 @@
 import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { IInputController } from './IInputController';
 import { Controller } from './GamepadTypes';
-/**
- * The class that handles the functionality of gamepads and controllers
- */
-export declare class GamePadController {
-    controllers: Array<Controller>;
-    requestAnimationFrame: (callback: FrameRequestCallback) => number;
-    toStreamerMessagesProvider: StreamMessageController;
-    private gamePadEventListenerTracker;
-    /**
-     * @param toStreamerMessagesProvider - Stream message instance
-     */
-    constructor(toStreamerMessagesProvider: StreamMessageController);
-    /**
-     * Unregister all event handlers.
-     */
-    unregisterGamePadEvents(): void;
-    /**
-     * Connects the gamepad handler
-     * @param gamePadEvent - the activating gamepad event
-     */
-    gamePadConnectHandler(gamePadEvent: GamepadEvent): void;
-    /**
-     * Disconnects the gamepad handler
-     * @param gamePadEvent - the activating gamepad event
-     */
-    gamePadDisconnectHandler(gamePadEvent: GamepadEvent): void;
-    /**
-     * Scan for connected gamepads
-     */
-    scanGamePads(): void;
-    /**
-     * Updates the status of the gamepad and sends the inputs
-     */
-    updateStatus(): void;
-    onGamepadResponseReceived(gamepadId: number): void;
-    /**
-     * Event to send the gamepadconnected message to the application
-     */
-    onGamepadConnected(): void;
-    /**
-     * Event to send the gamepaddisconnected message to the application
-     */
-    onGamepadDisconnected(controllerIdx: number): void;
-    onBeforeUnload(_: Event): void;
-}
 /**
  * Additional types for Window and Navigator
  */
@@ -60,7 +16,7 @@ declare global {
 /**
  * Gamepad layout codes enum
  */
-export declare enum gamepadLayout {
+export declare enum GamepadLayout {
     RightClusterBottomButton = 0,
     RightClusterRightButton = 1,
     RightClusterLeftButton = 2,
@@ -83,3 +39,23 @@ export declare enum gamepadLayout {
     RightStickHorizontal = 2,
     RightStickVertical = 3
 }
+/**
+ * Handles gamepad events from the document to send to the streamer.
+ */
+export declare class GamepadController implements IInputController {
+    controllers: Array<Controller>;
+    streamMessageController: StreamMessageController;
+    onGamepadConnectedListener: (event: GamepadEvent) => void;
+    onGamepadDisconnectedListener: (event: GamepadEvent) => void;
+    beforeUnloadListener: (event: Event) => void;
+    requestAnimationFrame: (callback: FrameRequestCallback) => number;
+    constructor(streamMessageController: StreamMessageController);
+    register(): void;
+    unregister(): void;
+    onGamepadResponseReceived(gamepadId: number): void;
+    private onGamepadConnected;
+    private onGamepadDisconnected;
+    private scanGamepads;
+    private updateStatus;
+    private onBeforeUnload;
+}

package/types/Inputs/GamepadTypes.d.ts

@@ -6,3 +6,10 @@ export interface Controller {
     prevState: Gamepad;
     id: number | undefined;
 }
+/**
+ * Deep copies the values from a gamepad by first converting it to a JSON object and then back to a gamepad
+ *
+ * @param gamepad the original gamepad
+ * @returns a new gamepad object, populated with the original gamepads values
+ */
+export declare function deepCopyGamepad(gamepad: Gamepad): Gamepad;

package/types/Inputs/IInputController.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The base interface for all input controllers.
+ * Since controllers mostly just register events and handle them the external interface is limited
+ * to register/unregister
+ */
+export interface IInputController {
+    /**
+     * Tells the controller to register itself to the events it needs to operate.
+     */
+    register(): void;
+    /**
+     * Tells the cnotroller to unregister from the events it previously registered to.
+     * No behaviour through the controller should happen past this point until register is called again.
+     */
+    unregister(): void;
+}