@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.0.8 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5",
-    "version": "0.0.8",
+    "version": "0.0.11",
     "description": "Frontend library for Unreal Engine 5.5 Pixel Streaming",
     "main": "dist/lib-pixelstreamingfrontend.js",
     "module": "dist/lib-pixelstreamingfrontend.esm.js",
@@ -16,11 +16,10 @@
         "spellcheck": "cspell \"{README.md,.github/*.md,src/**/*.ts}\""
     },
     "devDependencies": {
-        "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "^0.0.8",
+        "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "^0.0.13",
         "@types/jest": "27.5.1",
         "@types/webxr": "^0.5.1",
-        "@typescript-eslint/eslint-plugin": "^5.16.0",
-        "@typescript-eslint/parser": "^5.16.0",
+        "@typescript-eslint/eslint-plugin": "^6.21.0",
         "cspell": "^4.1.0",
         "eslint": "^8.11.0",
         "jest": "^27.5.1",
@@ -38,7 +37,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/EpicGames/PixelStreamingInfrastructure.git"
+        "url": "https://github.com/EpicGamesExt/PixelStreamingInfrastructure.git"
     },
     "author": "Epic Games",
     "license": "MIT",
@@ -46,4 +45,3 @@
         "access": "public"
     }
 }
-

package/src/Config/Config.ts

@@ -31,7 +31,8 @@ export class Flags {
     static TouchInput = 'TouchInput' as const;
     static GamepadInput = 'GamepadInput' as const;
     static XRControllerInput = 'XRControllerInput' as const;
-    static WaitForStreamer = "WaitForStreamer" as const;
+    static WaitForStreamer = 'WaitForStreamer' as const;
+    static HideUI = 'HideUI' as const;
 }
 
 export type FlagsKeys = Exclude<keyof typeof Flags, 'prototype'>;
@@ -181,7 +182,7 @@ export class Config {
                 TextParameters.SignallingServerUrl,
                 'Signalling url',
                 'Url of the signalling server',
-                settings && settings.hasOwnProperty(TextParameters.SignallingServerUrl) ? 
+                settings && Object.prototype.hasOwnProperty.call(settings, TextParameters.SignallingServerUrl) ? 
                     settings[TextParameters.SignallingServerUrl] :
                     (location.protocol === 'https:' ? 'wss://' : 'ws://') +
                         window.location.hostname +
@@ -200,7 +201,7 @@ export class Config {
                 OptionParameters.StreamerId,
                 'Streamer ID',
                 'The ID of the streamer to stream.',
-                settings && settings.hasOwnProperty(OptionParameters.StreamerId) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, OptionParameters.StreamerId) ?
                     settings[OptionParameters.StreamerId] :
                     '',
                 [],
@@ -218,7 +219,7 @@ export class Config {
                 'Preferred Codec',
                 'The preferred codec to be used during codec negotiation',
                 'H264 level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f',
-                settings && settings.hasOwnProperty(OptionParameters.PreferredCodec) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, OptionParameters.PreferredCodec) ?
                     [settings[OptionParameters.PreferredCodec]] :
                     (function (): Array<string> {
                         const browserSupportedCodecs: Array<string> = [];
@@ -257,7 +258,7 @@ export class Config {
                 Flags.AutoConnect,
                 'Auto connect to stream',
                 'Whether we should attempt to auto connect to the signalling server or show a click to start prompt.',
-                settings && settings.hasOwnProperty(Flags.AutoConnect) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.AutoConnect) ?
                     settings[Flags.AutoConnect] :
                     false,
                 useUrlParams
@@ -270,7 +271,7 @@ export class Config {
                 Flags.AutoPlayVideo,
                 'Auto play video',
                 'When video is ready automatically start playing it as opposed to showing a play button.',
-                settings && settings.hasOwnProperty(Flags.AutoPlayVideo) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.AutoPlayVideo) ?
                     settings[Flags.AutoPlayVideo] :
                     true,
                 useUrlParams
@@ -283,7 +284,7 @@ export class Config {
                 Flags.BrowserSendOffer,
                 'Browser send offer',
                 'Browser will initiate the WebRTC handshake by sending the offer to the streamer',
-                settings && settings.hasOwnProperty(Flags.BrowserSendOffer) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.BrowserSendOffer) ?
                     settings[Flags.BrowserSendOffer] :
                     false,
                 useUrlParams
@@ -296,7 +297,7 @@ export class Config {
                 Flags.UseMic,
                 'Use microphone',
                 'Make browser request microphone access and open an input audio track.',
-                settings && settings.hasOwnProperty(Flags.UseMic) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.UseMic) ?
                     settings[Flags.UseMic] :
                     false,
                 useUrlParams
@@ -309,7 +310,7 @@ export class Config {
                 Flags.StartVideoMuted,
                 'Start video muted',
                 'Video will start muted if true.',
-                settings && settings.hasOwnProperty(Flags.StartVideoMuted) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.StartVideoMuted) ?
                     settings[Flags.StartVideoMuted] :
                     false,
                 useUrlParams
@@ -322,7 +323,7 @@ export class Config {
                 Flags.SuppressBrowserKeys,
                 'Suppress browser keys',
                 'Suppress certain browser keys that we use in UE, for example F5 to show shader complexity instead of refresh the page.',
-                settings && settings.hasOwnProperty(Flags.SuppressBrowserKeys) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.SuppressBrowserKeys) ?
                     settings[Flags.SuppressBrowserKeys] :
                     true,
                 useUrlParams
@@ -335,7 +336,7 @@ export class Config {
                 Flags.IsQualityController,
                 'Is quality controller?',
                 'True if this peer controls stream quality',
-                settings && settings.hasOwnProperty(Flags.IsQualityController) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.IsQualityController) ?
                     settings[Flags.IsQualityController] :
                     true,
                 useUrlParams
@@ -348,7 +349,7 @@ export class Config {
                 Flags.ForceMonoAudio,
                 'Force mono audio',
                 'Force browser to request mono audio in the SDP',
-                settings && settings.hasOwnProperty(Flags.ForceMonoAudio) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.ForceMonoAudio) ?
                     settings[Flags.ForceMonoAudio] :
                     false,
                 useUrlParams
@@ -361,7 +362,7 @@ export class Config {
                 Flags.ForceTURN,
                 'Force TURN',
                 'Only generate TURN/Relayed ICE candidates.',
-                settings && settings.hasOwnProperty(Flags.ForceTURN) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.ForceTURN) ?
                     settings[Flags.ForceTURN] :
                     false,
                 useUrlParams
@@ -374,7 +375,7 @@ export class Config {
                 Flags.AFKDetection,
                 'AFK if idle',
                 'Timeout the experience if user is AFK for a period.',
-                settings && settings.hasOwnProperty(Flags.AFKDetection) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.AFKDetection) ?
                     settings[Flags.AFKDetection] :
                     false,
                 useUrlParams
@@ -387,7 +388,7 @@ export class Config {
                 Flags.MatchViewportResolution,
                 'Match viewport resolution',
                 'Pixel Streaming will be instructed to dynamically resize the video stream to match the size of the video element.',
-                settings && settings.hasOwnProperty(Flags.MatchViewportResolution) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.MatchViewportResolution) ?
                     settings[Flags.MatchViewportResolution] :
                     false,
                 useUrlParams
@@ -400,7 +401,7 @@ export class Config {
                 Flags.HoveringMouseMode,
                 'Control Scheme: Locked Mouse',
                 'Either locked mouse, where the pointer is consumed by the video and locked to it, or hovering mouse, where the mouse is not consumed.',
-                settings && settings.hasOwnProperty(Flags.HoveringMouseMode) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.HoveringMouseMode) ?
                     settings[Flags.HoveringMouseMode] :
                     false,
                 useUrlParams,
@@ -416,7 +417,7 @@ export class Config {
                 Flags.FakeMouseWithTouches,
                 'Fake mouse with touches',
                 'A single finger touch is converted into a mouse event. This allows a non-touch application to be controlled partially via a touch device.',
-                settings && settings.hasOwnProperty(Flags.FakeMouseWithTouches) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.FakeMouseWithTouches) ?
                     settings[Flags.FakeMouseWithTouches] :
                     true,
                 useUrlParams
@@ -429,7 +430,7 @@ export class Config {
                 Flags.KeyboardInput,
                 'Keyboard input',
                 'If enabled, send keyboard events to streamer',
-                settings && settings.hasOwnProperty(Flags.KeyboardInput) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.KeyboardInput) ?
                     settings[Flags.KeyboardInput] :
                     true,
                 useUrlParams
@@ -442,7 +443,7 @@ export class Config {
                 Flags.MouseInput,
                 'Mouse input',
                 'If enabled, send mouse events to streamer',
-                settings && settings.hasOwnProperty(Flags.MouseInput) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.MouseInput) ?
                     settings[Flags.MouseInput] :
                     true,
                 useUrlParams
@@ -455,7 +456,7 @@ export class Config {
                 Flags.TouchInput,
                 'Touch input',
                 'If enabled, send touch events to streamer',
-                settings && settings.hasOwnProperty(Flags.TouchInput) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.TouchInput) ?
                     settings[Flags.TouchInput] :
                     true,
                 useUrlParams
@@ -468,7 +469,7 @@ export class Config {
                 Flags.GamepadInput,
                 'Gamepad input',
                 'If enabled, send gamepad events to streamer',
-                settings && settings.hasOwnProperty(Flags.GamepadInput) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.GamepadInput) ?
                     settings[Flags.GamepadInput] :
                     true,
                 useUrlParams
@@ -481,7 +482,7 @@ export class Config {
                 Flags.XRControllerInput,
                 'XR controller input',
                 'If enabled, send XR controller events to streamer',
-                settings && settings.hasOwnProperty(Flags.XRControllerInput) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.XRControllerInput) ?
                     settings[Flags.XRControllerInput] :
                     true,
                 useUrlParams
@@ -494,12 +495,25 @@ export class Config {
                 Flags.WaitForStreamer,
                 'Wait for streamer',
                 'Will continue trying to connect to the first streamer available.',
-                settings && settings.hasOwnProperty(Flags.WaitForStreamer) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, Flags.WaitForStreamer) ?
                     settings[Flags.WaitForStreamer] :
                     true,
                 useUrlParams
             )
         );
+        
+        this.flags.set(
+            Flags.HideUI,
+            new SettingFlag(
+                Flags.HideUI,
+                'Hide the UI overlay',
+                'Will hide all UI overlay details',
+                settings && settings.hasOwnProperty(Flags.HideUI) ?
+                    settings[Flags.HideUI] :
+                    false,
+                useUrlParams
+            )
+        );
 
         /**
          * Numeric parameters
@@ -513,7 +527,7 @@ export class Config {
                 'The time (in seconds) it takes for the application to time out if AFK timeout is enabled.',
                 0 /*min*/,
                 600 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.AFKTimeoutSecs) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.AFKTimeoutSecs) ?
                     settings[NumericParameters.AFKTimeoutSecs] :
                     120, /*value*/
                 useUrlParams
@@ -528,7 +542,7 @@ export class Config {
                 'Maximum number of reconnects the application will attempt when a streamer disconnects.',
                 0 /*min*/,
                 999 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.MaxReconnectAttempts) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.MaxReconnectAttempts) ?
                     settings[NumericParameters.MaxReconnectAttempts] :
                     3, /*value*/
                 useUrlParams
@@ -543,7 +557,7 @@ export class Config {
                 'The lower bound for the quantization parameter (QP) of the encoder. 0 = Best quality, 51 = worst quality.',
                 0 /*min*/,
                 51 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.MinQP) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.MinQP) ?
                     settings[NumericParameters.MinQP] :
                     0, /*value*/
                 useUrlParams
@@ -558,7 +572,7 @@ export class Config {
                 'The upper bound for the quantization parameter (QP) of the encoder. 0 = Best quality, 51 = worst quality.',
                 0 /*min*/,
                 51 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.MaxQP) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.MaxQP) ?
                     settings[NumericParameters.MaxQP] :
                     51, /*value*/
                 useUrlParams
@@ -573,7 +587,7 @@ export class Config {
                 'The maximum FPS that WebRTC will try to transmit frames at.',
                 1 /*min*/,
                 999 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.WebRTCFPS) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.WebRTCFPS) ?
                     settings[NumericParameters.WebRTCFPS] :
                     60, /*value*/
                 useUrlParams
@@ -588,7 +602,7 @@ export class Config {
                 'The minimum bitrate that WebRTC should use.',
                 0 /*min*/,
                 500000 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.WebRTCMinBitrate) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.WebRTCMinBitrate) ?
                     settings[NumericParameters.WebRTCMinBitrate] :
                     0, /*value*/
                 useUrlParams
@@ -603,7 +617,7 @@ export class Config {
                 'The maximum bitrate that WebRTC should use.',
                 0 /*min*/,
                 500000 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.WebRTCMaxBitrate) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.WebRTCMaxBitrate) ?
                     settings[NumericParameters.WebRTCMaxBitrate] :
                     0, /*value*/
                 useUrlParams
@@ -618,7 +632,7 @@ export class Config {
                 'Delay between retries when waiting for an available streamer.',
                 500 /*min*/,
                 900000 /*max*/,
-                settings && settings.hasOwnProperty(NumericParameters.StreamerAutoJoinInterval) ?
+                settings && Object.prototype.hasOwnProperty.call(settings, NumericParameters.StreamerAutoJoinInterval) ?
                     settings[NumericParameters.StreamerAutoJoinInterval] :
                     3000, /*value*/
                 useUrlParams

package/src/Config/SettingOption.ts

@@ -24,7 +24,7 @@ export class SettingOption<
 		// eslint-disable-next-line @typescript-eslint/no-empty-function
 		defaultOnChangeListener: (changedValue: unknown, setting: SettingBase) => void = () => { /* Do nothing, to be overridden. */ }
     ) {
-        super(id, label, description, [defaultTextValue], defaultOnChangeListener);
+        super(id, label, description, defaultTextValue, defaultOnChangeListener);
 
         this.options = options;
         const urlParams = new URLSearchParams(window.location.search);

package/src/DataChannel/DataChannelLatencyTestController.ts

@@ -105,15 +105,15 @@ export class DataChannelLatencyTestController {
             );
             return;
         }
-        let record = this.records.get(response.Seq);
+        const record = this.records.get(response.Seq);
         if (record) {
             record.update(response);
         }
     }
 
     sendRequest(requestSize: number, responseSize: number) {
-        let request = this.createRequest(requestSize, responseSize);
-        let record = new DataChannelLatencyTestRecord(request);
+        const request = this.createRequest(requestSize, responseSize);
+        const record = new DataChannelLatencyTestRecord(request);
         this.records.set(record.seq, record);
         this.sink(request);
     }

package/src/Inputs/GamepadController.ts

@@ -260,7 +260,7 @@ export class GamePadController {
         // Default Functionality: Do Nothing
     }
 
-    onBeforeUnload(ev: Event) {
+    onBeforeUnload(_: Event) {
         // When a user navigates away from the page, we need to inform UE of all the disconnecting
         // controllers
         for(const controller of this.controllers) {
@@ -285,6 +285,8 @@ declare global {
     }
 }
 
+/* eslint-disable @typescript-eslint/no-duplicate-enum-values */
+
 /**
  * Gamepad layout codes enum
  */
@@ -312,3 +314,6 @@ export enum gamepadLayout {
     RightStickHorizontal = 2,
     RightStickVertical = 3
 }
+
+/* eslint-enable @typescript-eslint/no-duplicate-enum-values */
+

package/src/Inputs/TouchController.ts

@@ -178,7 +178,7 @@ export class TouchController implements ITouchController {
                         coord.x,
                         coord.y,
                         this.fingerIds.get(touch.identifier),
-                        this.maxByteValue * touch.force,
+                        this.maxByteValue * (touch.force > 0 ? touch.force : 1),
                         coord.inRange ? 1 : 0
                     ]);
                     break;
@@ -198,7 +198,7 @@ export class TouchController implements ITouchController {
                         coord.x,
                         coord.y,
                         this.fingerIds.get(touch.identifier),
-                        this.maxByteValue * touch.force,
+                        this.maxByteValue * (touch.force > 0 ? touch.force : 1),
                         coord.inRange ? 1 : 0
                     ]);
                     break;

package/src/PeerConnectionController/AggregatedStats.ts

@@ -25,7 +25,7 @@ export class AggregatedStats {
     inboundAudioStats: InboundAudioStats;
     lastVideoStats: InboundVideoStats;
     lastAudioStats: InboundAudioStats;
-    candidatePair: CandidatePairStats;
+    candidatePairs: Array<CandidatePairStats>;
     DataChannelStats: DataChannelStats;
     localCandidates: Array<CandidateStat>;
     remoteCandidates: Array<CandidateStat>;
@@ -33,11 +33,11 @@ export class AggregatedStats {
     sessionStats: SessionStats;
     streamStats: StreamStats;
     codecs: Map<string, string>;
+    transportStats: RTCTransportStats;
 
     constructor() {
         this.inboundVideoStats = new InboundVideoStats();
         this.inboundAudioStats = new InboundAudioStats();
-        this.candidatePair = new CandidatePairStats();
         this.DataChannelStats = new DataChannelStats();
         this.outBoundVideoStats = new OutBoundVideoStats();
         this.sessionStats = new SessionStats();
@@ -52,6 +52,7 @@ export class AggregatedStats {
     processStats(rtcStatsReport: RTCStatsReport) {
         this.localCandidates = new Array<CandidateStat>();
         this.remoteCandidates = new Array<CandidateStat>();
+        this.candidatePairs = new Array<CandidatePairStats>();
 
         rtcStatsReport.forEach((stat) => {
             const type: RTCStatsTypePS = stat.type;
@@ -94,6 +95,7 @@ export class AggregatedStats {
                     this.handleTrack(stat);
                     break;
                 case 'transport':
+                    this.handleTransport(stat);
                     break;
                 case 'stream':
                     this.handleStream(stat);
@@ -120,16 +122,10 @@ export class AggregatedStats {
      * @param stat - the stats coming in from ice candidates
      */
     handleCandidatePair(stat: CandidatePairStats) {
-        this.candidatePair.bytesReceived = stat.bytesReceived;
-        this.candidatePair.bytesSent = stat.bytesSent;
-        this.candidatePair.localCandidateId = stat.localCandidateId;
-        this.candidatePair.remoteCandidateId = stat.remoteCandidateId;
-        this.candidatePair.nominated = stat.nominated;
-        this.candidatePair.readable = stat.readable;
-        this.candidatePair.selected = stat.selected;
-        this.candidatePair.writable = stat.writable;
-        this.candidatePair.state = stat.state;
-        this.candidatePair.currentRoundTripTime = stat.currentRoundTripTime;
+
+        // Add the candidate pair to the candidate pair array
+        this.candidatePairs.push(stat)
+
     }
 
     /**
@@ -162,6 +158,8 @@ export class AggregatedStats {
         localCandidate.protocol = stat.protocol;
         localCandidate.candidateType = stat.candidateType;
         localCandidate.id = stat.id;
+        localCandidate.relayProtocol = stat.relayProtocol;
+        localCandidate.transportId = stat.transportId;
         this.localCandidates.push(localCandidate);
     }
 
@@ -171,12 +169,14 @@ export class AggregatedStats {
      */
     handleRemoteCandidate(stat: CandidateStat) {
         const RemoteCandidate = new CandidateStat();
-        RemoteCandidate.label = 'local-candidate';
+        RemoteCandidate.label = 'remote-candidate';
         RemoteCandidate.address = stat.address;
         RemoteCandidate.port = stat.port;
         RemoteCandidate.protocol = stat.protocol;
         RemoteCandidate.id = stat.id;
         RemoteCandidate.candidateType = stat.candidateType;
+        RemoteCandidate.relayProtocol = stat.relayProtocol;
+        RemoteCandidate.transportId = stat.transportId
         this.remoteCandidates.push(RemoteCandidate);
     }
 
@@ -269,6 +269,11 @@ export class AggregatedStats {
         }
     }
 
+    handleTransport(stat: RTCTransportStats){
+        this.transportStats = stat;
+    }
+
+
     handleCodec(stat: CodecStats) {
         const codecId = stat.id;
         const codecType = `${stat.mimeType
@@ -308,4 +313,20 @@ export class AggregatedStats {
     isNumber(value: unknown): boolean {
         return typeof value === 'number' && isFinite(value);
     }
+
+    /**
+     * Helper function to return the active candidate pair
+     * @returns The candidate pair that is currently receiving data
+     */
+    public getActiveCandidatePair(): CandidatePairStats | null {
+        
+        // Check if the RTCTransport stat is not undefined
+        if (this.transportStats){
+            // Return the candidate pair that matches the transport candidate pair id
+            return this.candidatePairs.find((candidatePair) => candidatePair.id === this.transportStats.selectedCandidatePairId, null);
+        }
+        
+        // Fall back to the selected candidate pair
+        return this.candidatePairs.find((candidatePair) => candidatePair.selected, null);
+    }  
 }

package/src/PeerConnectionController/CandidatePairStats.ts

@@ -6,12 +6,19 @@
 export class CandidatePairStats {
     bytesReceived: number;
     bytesSent: number;
+    currentRoundTripTime: number;
+    id: string;
+    lastPacketReceivedTimestamp: number;
+    lastPacketSentTimestamp: number;
     localCandidateId: string;
-    remoteCandidateId: string;
     nominated: boolean;
+    priority: number;
     readable: boolean;
-    writable: boolean;
+    remoteCandidateId: string;
     selected: boolean;
     state: string;
-    currentRoundTripTime: number;
+    timestamp: number;
+    transportId: string;
+    type: string;
+    writable: boolean;  
 }

package/src/PeerConnectionController/CandidateStat.ts

@@ -4,10 +4,12 @@
  * ICE Candidate Stat collected from the RTC Stats Report
  */
 export class CandidateStat {
-    label: string;
-    id: string;
     address: string;
     candidateType: string;
+    id: string;
+    label: string;    
     port: number;
     protocol: 'tcp' | 'udp';
+    relayProtocol: 'tcp' | 'udp' | 'tls';
+    transportId: string;
 }

package/src/PixelStreaming/PixelStreaming.test.ts

@@ -400,9 +400,9 @@ describe('PixelStreaming', () => {
             expect.objectContaining({
                 data: {
                     aggregatedStats: expect.objectContaining({
-                        candidatePair: expect.objectContaining({
-                            bytesReceived: 123
-                        }),
+                        candidatePairs: [
+                            expect.objectContaining({ bytesReceived: 123 })
+                        ],
                         localCandidates: [
                             expect.objectContaining({ address: 'mock-address' })
                         ]

package/src/PixelStreaming/PixelStreaming.ts

@@ -28,7 +28,8 @@ import {
     WebRtcSdpEvent,
     DataChannelLatencyTestResponseEvent,
     DataChannelLatencyTestResultEvent,
-    PlayerCountEvent
+    PlayerCountEvent,
+    WebRtcTCPRelayDetectedEvent
 } from '../Util/EventEmitter';
 import { WebXRController } from '../WebXR/WebXRController';
 import { MessageDirection } from '../UeInstanceMessage/StreamMessageController';
@@ -61,6 +62,7 @@ export class PixelStreaming {
     protected _webRtcController: WebRtcPlayerController;
     protected _webXrController: WebXRController;
     protected _dataChannelLatencyTestController: DataChannelLatencyTestController;
+
     /**
      * Configuration object. You can read or modify config through this object. Whenever
      * the configuration is changed, the library will emit a `settingsChanged` event.
@@ -115,6 +117,15 @@ export class PixelStreaming {
             this.onScreenKeyboardHelper.showOnScreenKeyboard(command);
 
         this._webXrController = new WebXRController(this._webRtcController);
+
+        this._setupWebRtcTCPRelayDetection = this._setupWebRtcTCPRelayDetection.bind(this)
+
+        // Add event listener for the webRtcConnected event
+        this._eventEmitter.addEventListener("webRtcConnected", (webRtcConnectedEvent: WebRtcConnectedEvent) => {
+
+            // Bind to the stats received event
+            this._eventEmitter.addEventListener("statsReceived",  this._setupWebRtcTCPRelayDetection);
+        });
     }
 
     /**
@@ -626,6 +637,28 @@ export class PixelStreaming {
         );
     }
 
+    // Sets up to emit the webrtc tcp relay detect event 
+    _setupWebRtcTCPRelayDetection(statsReceivedEvent: StatsReceivedEvent) {
+        // Get the active candidate pair
+        let activeCandidatePair = statsReceivedEvent.data.aggregatedStats.getActiveCandidatePair();
+                
+        // Check if the active candidate pair is not null
+        if (activeCandidatePair != null) {
+
+            // Get the local candidate assigned to the active candidate pair
+            let localCandidate = statsReceivedEvent.data.aggregatedStats.localCandidates.find((candidate) => candidate.id == activeCandidatePair.localCandidateId, null)
+
+            // Check if the local candidate is not null, candidate type is relay and the relay protocol is tcp
+            if (localCandidate != null && localCandidate.candidateType == 'relay' && localCandidate.relayProtocol == 'tcp') {
+
+                // Send the web rtc tcp relay detected event
+                this._eventEmitter.dispatchEvent(new WebRtcTCPRelayDetectedEvent());
+            }
+            // The check is completed and the stats listen event can be removed
+            this._eventEmitter.removeEventListener("statsReceived", this._setupWebRtcTCPRelayDetection);
+        }
+    }
+
     /**
      * Request a connection latency test.
      * NOTE: There are plans to refactor all request* functions. Expect changes if you use this!

package/src/UI/OnScreenKeyboard.ts

@@ -35,10 +35,7 @@ export class OnScreenKeyboard {
      * @returns unquantizeAndDenormalizeUnsigned object
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    unquantizeAndDenormalizeUnsigned(
-        x: number,
-        y: number
-    ): UnquantizedDenormalizedUnsignedCoord {
+    unquantizeAndDenormalizeUnsigned(x: number, y: number): UnquantizedDenormalizedUnsignedCoord {
         return null;
     }