@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.4.8 → 1.0.2

package/src/PixelStreaming/PixelStreaming.ts

@@ -11,6 +11,7 @@ import { OnScreenKeyboard } from '../UI/OnScreenKeyboard';
 import {
     PixelStreamingEventEmitter,
     InitialSettingsEvent,
+    LatencyCalculatedEvent,
     LatencyTestResultEvent,
     PixelStreamingEvent,
     StatsReceivedEvent,
@@ -30,7 +31,9 @@ import {
     DataChannelLatencyTestResultEvent,
     PlayerCountEvent,
     WebRtcTCPRelayDetectedEvent,
-    SubscribeFailedEvent
+    SubscribeFailedEvent,
+    WebRtcSdpOfferEvent,
+    WebRtcSdpAnswerEvent
 } from '../Util/EventEmitter';
 import { WebXRController } from '../WebXR/WebXRController';
 import { MessageDirection } from '../UeInstanceMessage/StreamMessageController';
@@ -44,6 +47,7 @@ import {
 } from '../DataChannel/DataChannelLatencyTestResults';
 import { RTCUtils } from '../Util/RTCUtils';
 import { IURLSearchParams } from '../Util/IURLSearchParams';
+import { LatencyInfo } from '../PeerConnectionController/LatencyCalculator';
 
 export interface PixelStreamingOverrides {
     /** The DOM element where Pixel Streaming video and user input event handlers are attached to.
@@ -450,21 +454,42 @@ export class PixelStreaming {
     }
 
     /**
-     * Emit an event on auto connecting
+     * Internal function to emit an event when auto connecting occurs
      */
     _onWebRtcAutoConnect() {
         this._eventEmitter.dispatchEvent(new WebRtcAutoConnectEvent());
     }
 
     /**
-     * Set up functionality to happen when receiving a webRTC answer
+     * Internal function to emit an event for when SDP negotiation is fully finished.
      */
     _onWebRtcSdp() {
         this._eventEmitter.dispatchEvent(new WebRtcSdpEvent());
     }
 
     /**
-     * Emits a StreamLoading event
+     * Internal function to emit an SDP offer after it has been set.
+     */
+    _onWebRtcSdpOffer(offer: RTCSessionDescriptionInit) {
+        this._eventEmitter.dispatchEvent(new WebRtcSdpOfferEvent({ sdp: offer }));
+    }
+
+    /**
+     * Internal function to emit an SDP answer after it has been set.
+     */
+    _onWebRtcSdpAnswer(answer: RTCSessionDescriptionInit) {
+        this._eventEmitter.dispatchEvent(new WebRtcSdpAnswerEvent({ sdp: answer }));
+    }
+
+    /**
+     * Internal function call to emit a `latencyCalculated` event.
+     */
+    _onLatencyCalculated(latencyInfo: LatencyInfo) {
+        this._eventEmitter.dispatchEvent(new LatencyCalculatedEvent({ latencyInfo }));
+    }
+
+    /**
+     * Internal function to emits a StreamLoading event
      */
     _onStreamLoading() {
         this._eventEmitter.dispatchEvent(new StreamLoadingEvent());

package/src/UI/OnScreenKeyboard.ts

@@ -81,9 +81,13 @@ export class OnScreenKeyboard {
      * @param command the command received via the data channel containing keyboard positions
      */
     showOnScreenKeyboard(command: any) {
+        if (!this.editTextButton) {
+            return;
+        }
+        
         if (command.showOnScreenKeyboard) {
             // Show the 'edit text' button.
-            this.editTextButton.style.display = 'default';
+            this.editTextButton.style.display = 'block';
             // Place the 'edit text' button near the UE input widget.
             const pos = this.unquantizeAndDenormalizeUnsigned(command.x, command.y);
             this.editTextButton.style.top = pos.y.toString() + 'px';

package/src/Util/EventEmitter.ts

@@ -2,6 +2,7 @@ import { FlagsIds, NumericParametersIds, OptionParametersIds, TextParametersIds
 import { LatencyTestResults } from '../DataChannel/LatencyTestResults';
 import { AggregatedStats } from '../PeerConnectionController/AggregatedStats';
 import { InitialSettings } from '../DataChannel/InitialSettings';
+import { LatencyInfo } from '../PeerConnectionController/LatencyCalculator';
 import { Messages } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
 import { SettingFlag } from '../Config/SettingFlag';
 import { SettingNumber } from '../Config/SettingNumber';
@@ -90,6 +91,36 @@ export class WebRtcSdpEvent extends Event {
     }
 }
 
+/**
+ * An event that is emitted after the SDP answer is set.
+ */
+export class WebRtcSdpAnswerEvent extends Event {
+    override readonly type: 'webRtcSdpAnswer';
+    readonly data: {
+        /** The sdp answer */
+        sdp: RTCSessionDescriptionInit;
+    };
+    constructor(data: WebRtcSdpAnswerEvent['data']) {
+        super('webRtcSdpAnswer');
+        this.data = data;
+    }
+}
+
+/**
+ * An event that is emitted after the SDP offer is set.
+ */
+export class WebRtcSdpOfferEvent extends Event {
+    override readonly type: 'webRtcSdpOffer';
+    readonly data: {
+        /** The sdp offer */
+        sdp: RTCSessionDescriptionInit;
+    };
+    constructor(data: WebRtcSdpOfferEvent['data']) {
+        super('webRtcSdpOffer');
+        this.data = data;
+    }
+}
+
 /**
  * An event that is emitted when auto connecting.
  */
@@ -382,6 +413,20 @@ export class LatencyTestResultEvent extends Event {
     }
 }
 
+/**
+ * An event that is emitted everytime latency is calculated using the WebRTC stats API.
+ */
+export class LatencyCalculatedEvent extends Event {
+    override readonly type: 'latencyCalculated';
+    readonly data: {
+        latencyInfo: LatencyInfo;
+    };
+    constructor(data: LatencyCalculatedEvent['data']) {
+        super('latencyCalculated');
+        this.data = data;
+    }
+}
+
 /**
  * An event that is emitted when receiving data channel latency test response from server.
  * This event is handled by DataChannelLatencyTestController
@@ -560,6 +605,8 @@ export type PixelStreamingEvent =
     | AfkTimedOutEvent
     | VideoEncoderAvgQPEvent
     | WebRtcSdpEvent
+    | WebRtcSdpOfferEvent
+    | WebRtcSdpAnswerEvent
     | WebRtcAutoConnectEvent
     | WebRtcConnectingEvent
     | WebRtcConnectedEvent
@@ -581,6 +628,7 @@ export type PixelStreamingEvent =
     | StatsReceivedEvent
     | StreamerListMessageEvent
     | StreamerIDChangedMessageEvent
+    | LatencyCalculatedEvent
     | LatencyTestResultEvent
     | DataChannelLatencyTestResponseEvent
     | DataChannelLatencyTestResultEvent

package/src/VideoPlayer/VideoPlayer.ts

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

package/src/WebRtcPlayer/WebRtcPlayerController.ts

@@ -55,6 +55,7 @@ import {
 import { IURLSearchParams } from '../Util/IURLSearchParams';
 import { IInputController } from '../Inputs/IInputController';
 import { GamepadController } from '../Inputs/GamepadController';
+import { LatencyInfo } from '../PeerConnectionController/LatencyCalculator';
 
 /**
  * Entry point for the WebRTC Player
@@ -1075,15 +1076,29 @@ export class WebRtcPlayerController {
         );
 
         // set up peer connection controller video stats
-        this.peerConnectionController.onVideoStats = (event: AggregatedStats) => this.handleVideoStats(event);
+        this.peerConnectionController.onVideoStats = (event: AggregatedStats) => {
+            this.handleVideoStats(event);
+        };
+
+        /* Set event handler for latency information is calculated, handle the event by propogating to the PixelStreaming API */
+        this.peerConnectionController.onLatencyCalculated = (latencyInfo: LatencyInfo) => {
+            this.pixelStreaming._onLatencyCalculated(latencyInfo);
+        };
 
         /* When the Peer Connection wants to send an offer have it handled */
-        this.peerConnectionController.onSendWebRTCOffer = (offer: RTCSessionDescriptionInit) =>
+        this.peerConnectionController.onSendWebRTCOffer = (offer: RTCSessionDescriptionInit) => {
             this.handleSendWebRTCOffer(offer);
+        };
 
-        /* When the Peer Connection wants to send an answer have it handled */
-        this.peerConnectionController.onSendWebRTCAnswer = (offer: RTCSessionDescriptionInit) =>
-            this.handleSendWebRTCAnswer(offer);
+        /* Set event handler for when local answer description is set */
+        this.peerConnectionController.onSetLocalDescription = (answer: RTCSessionDescriptionInit) => {
+            this.handleSendWebRTCAnswer(answer);
+        };
+
+        /* Set event handler for when remote offer description is set */
+        this.peerConnectionController.onSetRemoteDescription = (offer: RTCSessionDescriptionInit) => {
+            this.pixelStreaming._onWebRtcSdpOffer(offer);
+        };
 
         /* When the Peer Connection ice candidate is added have it handled */
         this.peerConnectionController.onPeerIceCandidate = (
@@ -1484,6 +1499,9 @@ export class WebRtcPlayerController {
         if (this.isUsingSFU) {
             this.protocol.sendMessage(MessageHelpers.createMessage(Messages.dataChannelRequest));
         }
+
+        // Send answer back to Pixel Streaming main class for event dispatch
+        this.pixelStreaming._onWebRtcSdpAnswer(answer);
     }
 
     /**

package/src/__test__/mockRTCPeerConnection.ts

@@ -111,7 +111,7 @@ export class MockRTCPeerConnectionImpl implements RTCPeerConnection {
         throw new Error("Method not implemented.");
     }
     getReceivers(): RTCRtpReceiver[] {
-        throw new Error("Method not implemented.");
+        return [];
     }
     getSenders(): RTCRtpSender[] {
         throw new Error("Method not implemented.");

package/src/pixelstreamingfrontend.ts

@@ -19,7 +19,8 @@ export { CandidatePairStats } from './PeerConnectionController/CandidatePairStat
 export { CandidateStat } from './PeerConnectionController/CandidateStat';
 export { DataChannelStats } from './PeerConnectionController/DataChannelStats';
 export { InboundAudioStats, InboundVideoStats } from './PeerConnectionController/InboundRTPStats';
-export { OutBoundVideoStats } from './PeerConnectionController/OutBoundRTPStats';
+export { OutboundRTPStats, RemoteOutboundRTPStats } from './PeerConnectionController/OutBoundRTPStats';
+export * from './PeerConnectionController/LatencyCalculator';
 export * from './DataChannel/DataChannelLatencyTestResults';
 export * from './Util/EventEmitter';
 export * from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';

package/tsconfig.base.json

@@ -15,8 +15,8 @@
         "declarationDir": "./dist/types"
     },
     "lib": ["ES6"],
-    "include": ["./src/*.ts"],
-    "exclude": ["./src/**/*.test.ts", "./coverage/**", "./dist/**"],
+    "include": ["./src/**/*.ts"],
+    "exclude": ["./src/**/*.test.ts"],
     "typedocOptions": {
         "exclude": "src/index.*",
         "entryPoints": ["src/pixelstreamingfrontend.ts"],

package/.eslintignore

@@ -1,12 +0,0 @@
-dist
-node_modules
-types
-package-lock.json
-package.json
-tsconfig.json
-*.config.js
-.eslintrc.js
-src/__test__/
-webpack.*.js
-*.test.ts
-coverage

package/.eslintrc.js

@@ -1,20 +0,0 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-
-module.exports = {
-    root: true,
-    parser: '@typescript-eslint/parser',
-    parserOptions: { project: './tsconfig.cjs.json' },
-    plugins: ['@typescript-eslint'],
-    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', "plugin:prettier/recommended"],
-    rules: {
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-unused-vars": [
-            "error",
-            {
-                "argsIgnorePattern": "^_",
-                "varsIgnorePattern": "^_",
-                "caughtErrorsIgnorePattern": "^_"
-            }
-        ]
-    }
-};

package/.prettierrc.json

@@ -1,7 +0,0 @@
-{
-    "printWidth": 110,
-    "trailingComma": "none",
-    "tabWidth": 4,
-    "semi": true,
-    "singleQuote": true
-}