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

package/src/Util/EventEmitter.ts

@@ -537,6 +537,16 @@ 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';
+    constructor() {
+        super('webRtcTCPRelayDetected');
+    }
+}
+
 export type PixelStreamingEvent =
     | AfkWarningActivateEvent
     | AfkWarningUpdateEvent
@@ -573,7 +583,8 @@ export type PixelStreamingEvent =
     | XrSessionStartedEvent
     | XrSessionEndedEvent
     | XrFrameEvent
-    | PlayerCountEvent;
+    | PlayerCountEvent
+    | WebRtcTCPRelayDetectedEvent;
 
 export class EventEmitter extends EventTarget {
     /**

package/src/WebRtcPlayer/WebRtcPlayerController.ts

@@ -25,9 +25,7 @@ import {
     NumericParameters
 } from '../Config/Config';
 import {
-    EncoderSettings,
     InitialSettings,
-    WebRTCSettings
 } from '../DataChannel/InitialSettings';
 import { LatencyTestResults } from '../DataChannel/LatencyTestResults';
 import { FileTemplate, FileUtil } from '../Util/FileUtil';
@@ -192,44 +190,44 @@ export class WebRtcPlayerController {
         // set up websocket methods
         this.transport = new WebSocketTransport();
         this.protocol = new SignallingProtocol(this.transport);
-        this.protocol.messageHandlers.addListener(Messages.config.typeName, (msg: BaseMessage) =>
+        this.protocol.addListener(Messages.config.typeName, (msg: BaseMessage) =>
             this.handleOnConfigMessage(msg as Messages.config)
         );
-        this.protocol.messageHandlers.addListener(Messages.streamerList.typeName, (msg: BaseMessage) =>
+        this.protocol.addListener(Messages.streamerList.typeName, (msg: BaseMessage) =>
             this.handleStreamerListMessage(msg as Messages.streamerList)
         );
-        this.protocol.messageHandlers.addListener(Messages.streamerIdChanged.typeName, (msg: BaseMessage) =>
+        this.protocol.addListener(Messages.streamerIdChanged.typeName, (msg: BaseMessage) =>
             this.handleStreamerIDChangedMessage(msg as Messages.streamerIdChanged)
         );
-        this.protocol.messageHandlers.addListener(Messages.playerCount.typeName, (msg: BaseMessage) => {
+        this.protocol.addListener(Messages.playerCount.typeName, (msg: BaseMessage) => {
             const playerCountMessage = msg as Messages.playerCount;
             this.pixelStreaming._onPlayerCount(playerCountMessage.count);
         });
-        this.protocol.messageHandlers.addListener(Messages.answer.typeName, (msg: BaseMessage) =>
+        this.protocol.addListener(Messages.answer.typeName, (msg: BaseMessage) =>
             this.handleWebRtcAnswer(msg as Messages.answer)
         );
-        this.protocol.messageHandlers.addListener(Messages.offer.typeName, (msg: BaseMessage) =>
+        this.protocol.addListener(Messages.offer.typeName, (msg: BaseMessage) =>
             this.handleWebRtcOffer(msg as Messages.offer)
         );
-        this.protocol.messageHandlers.addListener(Messages.streamerDataChannels.typeName, (msg: BaseMessage) =>
-            this.handleWebRtcSFUPeerDatachannels(msg as Messages.streamerDataChannels)
+        this.protocol.addListener(Messages.peerDataChannels.typeName, (msg: BaseMessage) =>
+            this.handleWebRtcSFUPeerDatachannels(msg as Messages.peerDataChannels)
         );
-        this.protocol.messageHandlers.addListener(Messages.iceCandidate.typeName, (msg: BaseMessage) => {
+        this.protocol.addListener(Messages.iceCandidate.typeName, (msg: BaseMessage) => {
             const iceCandidateMessage = msg as Messages.iceCandidate;
             this.handleIceCandidate(iceCandidateMessage.candidate);
         });
-        this.protocol.transportEvents.addListener('open', () => {
+        this.protocol.transport.addListener('open', () => {
             const BrowserSendsOffer = this.config.isFlagEnabled(Flags.BrowserSendOffer);
             if (!BrowserSendsOffer) {
                 const message = MessageHelpers.createMessage(Messages.listStreamers);
                 this.protocol.sendMessage(message);
             }
         });
-        this.protocol.transportEvents.addListener('error', () => {
+        this.protocol.transport.addListener('error', () => {
             // dont really need to do anything here since the close event should follow.
             Logger.Error(Logger.GetStackTrace(), `Got a transport error.`);
         });
-        this.protocol.transportEvents.addListener('close', (event: CloseEvent) => {
+        this.protocol.transport.addListener('close', (event: CloseEvent) => {
             // when we refresh the page during a stream we get the going away code.
             // in that case we don't want to reconnect since we're navigating away.
             // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
@@ -1331,7 +1329,7 @@ export class WebRtcPlayerController {
         // get the current selected streamer id option
         const streamerIDOption = this.config.getSettingOption(OptionParameters.StreamerId);
         const existingSelection = streamerIDOption.selected.toString().trim();
-        if (!!existingSelection) {
+        if (existingSelection) {
             // default to selected option if it exists
             wantedStreamerId = streamerIDOption.selected;
         }
@@ -1386,7 +1384,7 @@ export class WebRtcPlayerController {
                     this.isReconnecting = true;
                     this.reconnectAttempt++;
                     setTimeout(() => {
-                        this.protocol.requestStreamerList();
+                        this.protocol.sendMessage(MessageHelpers.createMessage(Messages.listStreamers));
                     }, reconnectDelay);
                 } else {
                     // We've exhausted our reconnect attempts, return to main screen
@@ -1488,7 +1486,7 @@ export class WebRtcPlayerController {
      * Handle when the SFU provides the peer with its data channels
      * @param DataChannels - The message from the SFU containing the data channels ids
      */
-    handleWebRtcSFUPeerDatachannels(DataChannels: Messages.streamerDataChannels) {
+    handleWebRtcSFUPeerDatachannels(DataChannels: Messages.peerDataChannels) {
         const SendOptions: RTCDataChannelInit = {
             ordered: true,
             negotiated: true,
@@ -1517,7 +1515,7 @@ export class WebRtcPlayerController {
                 RecvOptions
             );
             this.recvDataChannelController.handleOnOpen = () =>
-                this.protocol.sendSFURecvDataChannelReady();
+                this.protocol.sendMessage(MessageHelpers.createMessage(Messages.peerDataChannelsReady));
             // If we're uni-directional, only the recv data channel should handle incoming messages
             this.recvDataChannelController.handleOnMessage = (
                 ev: MessageEvent
@@ -1570,7 +1568,7 @@ export class WebRtcPlayerController {
     handleSendIceCandidate(iceEvent: RTCPeerConnectionIceEvent) {
         Logger.Log(Logger.GetStackTrace(), 'OnIceCandidate', 6);
         if (iceEvent.candidate && iceEvent.candidate.candidate) {
-            this.protocol.sendIceCandidate(iceEvent.candidate);
+            this.protocol.sendMessage(MessageHelpers.createMessage(Messages.iceCandidate, { candidate: iceEvent.candidate }));
         }
     }
 
@@ -1610,7 +1608,7 @@ export class WebRtcPlayerController {
             maxBitrateBps: 1000 * this.config.getNumericSettingValue(NumericParameters.WebRTCMaxBitrate)
         };
 
-        this.protocol.sendWebRtcOffer(MessageHelpers.createMessage(Messages.offer, extraParams));
+        this.protocol.sendMessage(MessageHelpers.createMessage(Messages.offer, extraParams));
     }
 
     /**
@@ -1630,10 +1628,10 @@ export class WebRtcPlayerController {
             maxBitrateBps: 1000 * this.config.getNumericSettingValue(NumericParameters.WebRTCMaxBitrate)
         };
 
-        this.protocol.sendWebRtcOffer(MessageHelpers.createMessage(Messages.answer, extraParams));
+        this.protocol.sendMessage(MessageHelpers.createMessage(Messages.answer, extraParams));
 
         if (this.isUsingSFU) {
-            this.protocol.sendWebRtcDatachannelRequest();
+            this.protocol.sendMessage(MessageHelpers.createMessage(Messages.dataChannelRequest));
         }
     }
 

package/src/WebXR/WebXRController.ts

@@ -193,7 +193,7 @@ export class WebXRController {
 
         if (this.webRtcController.config.isFlagEnabled(Flags.XRControllerInput)) {
             this.xrSession.inputSources.forEach(
-                (source: XRInputSource, index: number, array: XRInputSource[]) => {
+                (source: XRInputSource, _index: number, _array: XRInputSource[]) => {
                     this.xrGamepadController.updateStatus(
                         source,
                         frame,

package/types/Config/Config.d.ts

@@ -27,6 +27,7 @@ export declare class Flags {
     static GamepadInput: "GamepadInput";
     static XRControllerInput: "XRControllerInput";
     static WaitForStreamer: "WaitForStreamer";
+    static HideUI: "HideUI";
 }
 export type FlagsKeys = Exclude<keyof typeof Flags, 'prototype'>;
 export type FlagsIds = typeof Flags[FlagsKeys];

package/types/Inputs/GamepadController.d.ts

@@ -43,7 +43,7 @@ export declare class GamePadController {
      * Event to send the gamepaddisconnected message to the application
      */
     onGamepadDisconnected(controllerIdx: number): void;
-    onBeforeUnload(ev: Event): void;
+    onBeforeUnload(_: Event): void;
 }
 /**
  * Additional types for Window and Navigator

package/types/PeerConnectionController/AggregatedStats.d.ts

@@ -12,7 +12,7 @@ export declare class AggregatedStats {
     inboundAudioStats: InboundAudioStats;
     lastVideoStats: InboundVideoStats;
     lastAudioStats: InboundAudioStats;
-    candidatePair: CandidatePairStats;
+    candidatePairs: Array<CandidatePairStats>;
     DataChannelStats: DataChannelStats;
     localCandidates: Array<CandidateStat>;
     remoteCandidates: Array<CandidateStat>;
@@ -20,6 +20,7 @@ export declare class AggregatedStats {
     sessionStats: SessionStats;
     streamStats: StreamStats;
     codecs: Map<string, string>;
+    transportStats: RTCTransportStats;
     constructor();
     /**
      * Gather all the information from the RTC Peer Connection Report
@@ -67,6 +68,7 @@ export declare class AggregatedStats {
      * @param stat - video track stats
      */
     handleTrack(stat: InboundTrackStats): void;
+    handleTransport(stat: RTCTransportStats): void;
     handleCodec(stat: CodecStats): void;
     handleSessionStatistics(videoStartTime: number, inputController: boolean | null, videoEncoderAvgQP: number): void;
     /**
@@ -74,4 +76,9 @@ export declare class AggregatedStats {
      * @param value - the number to be checked
      */
     isNumber(value: unknown): boolean;
+    /**
+     * Helper function to return the active candidate pair
+     * @returns The candidate pair that is currently receiving data
+     */
+    getActiveCandidatePair(): CandidatePairStats | null;
 }

package/types/PeerConnectionController/CandidatePairStats.d.ts

@@ -4,12 +4,19 @@
 export declare 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/types/PeerConnectionController/CandidateStat.d.ts

@@ -2,10 +2,12 @@
  * ICE Candidate Stat collected from the RTC Stats Report
  */
 export declare 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/types/PixelStreaming/PixelStreaming.d.ts

@@ -3,7 +3,7 @@ import { LatencyTestResults } from '../DataChannel/LatencyTestResults';
 import { AggregatedStats } from '../PeerConnectionController/AggregatedStats';
 import { WebRtcPlayerController } from '../WebRtcPlayer/WebRtcPlayerController';
 import { InitialSettings } from '../DataChannel/InitialSettings';
-import { PixelStreamingEvent } from '../Util/EventEmitter';
+import { PixelStreamingEvent, StatsReceivedEvent } from '../Util/EventEmitter';
 import { WebXRController } from '../WebXR/WebXRController';
 import { MessageDirection } from '../UeInstanceMessage/StreamMessageController';
 import { DataChannelLatencyTestConfig, DataChannelLatencyTestController } from "../DataChannel/DataChannelLatencyTestController";
@@ -159,6 +159,7 @@ export declare class PixelStreaming {
      */
     _onQualityControlOwnership(hasQualityOwnership: boolean): void;
     _onPlayerCount(playerCount: number): void;
+    _setupWebRtcTCPRelayDetection(statsReceivedEvent: StatsReceivedEvent): void;
     /**
      * Request a connection latency test.
      * NOTE: There are plans to refactor all request* functions. Expect changes if you use this!

package/types/Util/EventEmitter.d.ts

@@ -395,7 +395,14 @@ export declare class PlayerCountEvent extends Event {
     };
     constructor(data: PlayerCountEvent['data']);
 }
-export type PixelStreamingEvent = AfkWarningActivateEvent | AfkWarningUpdateEvent | AfkWarningDeactivateEvent | AfkTimedOutEvent | VideoEncoderAvgQPEvent | WebRtcSdpEvent | WebRtcAutoConnectEvent | WebRtcConnectingEvent | WebRtcConnectedEvent | WebRtcFailedEvent | WebRtcDisconnectedEvent | DataChannelOpenEvent | DataChannelCloseEvent | DataChannelErrorEvent | VideoInitializedEvent | StreamLoadingEvent | StreamPreConnectEvent | StreamReconnectEvent | StreamPreDisconnectEvent | PlayStreamErrorEvent | PlayStreamEvent | PlayStreamRejectedEvent | LoadFreezeFrameEvent | HideFreezeFrameEvent | StatsReceivedEvent | StreamerListMessageEvent | StreamerIDChangedMessageEvent | LatencyTestResultEvent | DataChannelLatencyTestResponseEvent | DataChannelLatencyTestResultEvent | InitialSettingsEvent | SettingsChangedEvent | XrSessionStartedEvent | XrSessionEndedEvent | XrFrameEvent | PlayerCountEvent;
+/**
+ * An event that is emitted when the webRTC connections is relayed over TCP.
+ */
+export declare class WebRtcTCPRelayDetectedEvent extends Event {
+    readonly type: 'webRtcTCPRelayDetected';
+    constructor();
+}
+export type PixelStreamingEvent = AfkWarningActivateEvent | AfkWarningUpdateEvent | AfkWarningDeactivateEvent | AfkTimedOutEvent | VideoEncoderAvgQPEvent | WebRtcSdpEvent | WebRtcAutoConnectEvent | WebRtcConnectingEvent | WebRtcConnectedEvent | WebRtcFailedEvent | WebRtcDisconnectedEvent | DataChannelOpenEvent | DataChannelCloseEvent | DataChannelErrorEvent | VideoInitializedEvent | StreamLoadingEvent | StreamPreConnectEvent | StreamReconnectEvent | StreamPreDisconnectEvent | PlayStreamErrorEvent | PlayStreamEvent | PlayStreamRejectedEvent | LoadFreezeFrameEvent | HideFreezeFrameEvent | StatsReceivedEvent | StreamerListMessageEvent | StreamerIDChangedMessageEvent | LatencyTestResultEvent | DataChannelLatencyTestResponseEvent | DataChannelLatencyTestResultEvent | InitialSettingsEvent | SettingsChangedEvent | XrSessionStartedEvent | XrSessionEndedEvent | XrFrameEvent | PlayerCountEvent | WebRtcTCPRelayDetectedEvent;
 export declare class EventEmitter extends EventTarget {
     /**
      * Dispatch a new event.

package/types/WebRtcPlayer/WebRtcPlayerController.d.ts

@@ -196,7 +196,7 @@ export declare class WebRtcPlayerController {
      * Handle when the SFU provides the peer with its data channels
      * @param DataChannels - The message from the SFU containing the data channels ids
      */
-    handleWebRtcSFUPeerDatachannels(DataChannels: Messages.streamerDataChannels): void;
+    handleWebRtcSFUPeerDatachannels(DataChannels: Messages.peerDataChannels): void;
     handlePostWebrtcNegotiation(): void;
     /**
      * When an ice Candidate is received from the Signaling server add it to the Peer Connection Client