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

package/src/PeerConnectionController/AggregatedStats.ts

@@ -5,7 +5,7 @@ import { InboundTrackStats } from './InboundTrackStats';
 import { DataChannelStats } from './DataChannelStats';
 import { CandidateStat } from './CandidateStat';
 import { CandidatePairStats } from './CandidatePairStats';
-import { OutBoundRTPStats, OutBoundVideoStats } from './OutBoundRTPStats';
+import { RemoteOutboundRTPStats, OutboundRTPStats } from './OutBoundRTPStats';
 import { SessionStats } from './SessionStats';
 import { StreamStats } from './StreamStats';
 import { CodecStats } from './CodecStats';
@@ -15,15 +15,17 @@ import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
  * The Aggregated Stats that is generated from the RTC Stats Report
  */
 
-type RTCStatsTypePS = RTCStatsType | 'stream' | 'media-playout' | 'track';
 export class AggregatedStats {
     inboundVideoStats: InboundVideoStats;
     inboundAudioStats: InboundAudioStats;
     candidatePairs: Array<CandidatePairStats>;
-    DataChannelStats: DataChannelStats;
+    datachannelStats: DataChannelStats;
     localCandidates: Array<CandidateStat>;
     remoteCandidates: Array<CandidateStat>;
-    outBoundVideoStats: OutBoundVideoStats;
+    outboundVideoStats: OutboundRTPStats;
+    outboundAudioStats: OutboundRTPStats;
+    remoteOutboundVideoStats: RemoteOutboundRTPStats;
+    remoteOutboundAudioStats: RemoteOutboundRTPStats;
     sessionStats: SessionStats;
     streamStats: StreamStats;
     codecs: Map<string, CodecStats>;
@@ -32,8 +34,11 @@ export class AggregatedStats {
     constructor() {
         this.inboundVideoStats = new InboundVideoStats();
         this.inboundAudioStats = new InboundAudioStats();
-        this.DataChannelStats = new DataChannelStats();
-        this.outBoundVideoStats = new OutBoundVideoStats();
+        this.datachannelStats = new DataChannelStats();
+        this.outboundVideoStats = new OutboundRTPStats();
+        this.outboundAudioStats = new OutboundRTPStats();
+        this.remoteOutboundAudioStats = new RemoteOutboundRTPStats();
+        this.remoteOutboundVideoStats = new RemoteOutboundRTPStats();
         this.sessionStats = new SessionStats();
         this.streamStats = new StreamStats();
         this.codecs = new Map<string, CodecStats>();
@@ -49,7 +54,7 @@ export class AggregatedStats {
         this.candidatePairs = new Array<CandidatePairStats>();
 
         rtcStatsReport.forEach((stat) => {
-            const type: RTCStatsTypePS = stat.type;
+            const type: string = stat.type;
 
             switch (type) {
                 case 'candidate-pair':
@@ -64,7 +69,7 @@ export class AggregatedStats {
                     this.handleDataChannel(stat);
                     break;
                 case 'inbound-rtp':
-                    this.handleInBoundRTP(stat);
+                    this.handleInboundRTP(stat);
                     break;
                 case 'local-candidate':
                     this.handleLocalCandidate(stat);
@@ -74,6 +79,7 @@ export class AggregatedStats {
                 case 'media-playout':
                     break;
                 case 'outbound-rtp':
+                    this.handleLocalOutbound(stat);
                     break;
                 case 'peer-connection':
                     break;
@@ -83,7 +89,7 @@ export class AggregatedStats {
                 case 'remote-inbound-rtp':
                     break;
                 case 'remote-outbound-rtp':
-                    this.handleRemoteOutBound(stat);
+                    this.handleRemoteOutbound(stat);
                     break;
                 case 'track':
                     this.handleTrack(stat);
@@ -125,16 +131,16 @@ export class AggregatedStats {
      * @param stat - the stats coming in from the data channel
      */
     handleDataChannel(stat: DataChannelStats) {
-        this.DataChannelStats.bytesReceived = stat.bytesReceived;
-        this.DataChannelStats.bytesSent = stat.bytesSent;
-        this.DataChannelStats.dataChannelIdentifier = stat.dataChannelIdentifier;
-        this.DataChannelStats.id = stat.id;
-        this.DataChannelStats.label = stat.label;
-        this.DataChannelStats.messagesReceived = stat.messagesReceived;
-        this.DataChannelStats.messagesSent = stat.messagesSent;
-        this.DataChannelStats.protocol = stat.protocol;
-        this.DataChannelStats.state = stat.state;
-        this.DataChannelStats.timestamp = stat.timestamp;
+        this.datachannelStats.bytesReceived = stat.bytesReceived;
+        this.datachannelStats.bytesSent = stat.bytesSent;
+        this.datachannelStats.dataChannelIdentifier = stat.dataChannelIdentifier;
+        this.datachannelStats.id = stat.id;
+        this.datachannelStats.label = stat.label;
+        this.datachannelStats.messagesReceived = stat.messagesReceived;
+        this.datachannelStats.messagesSent = stat.messagesSent;
+        this.datachannelStats.protocol = stat.protocol;
+        this.datachannelStats.state = stat.state;
+        this.datachannelStats.timestamp = stat.timestamp;
     }
 
     /**
@@ -159,23 +165,23 @@ export class AggregatedStats {
      * @param stat - ice candidate stats
      */
     handleRemoteCandidate(stat: CandidateStat) {
-        const RemoteCandidate = new CandidateStat();
-        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);
+        const remoteCandidate = new CandidateStat();
+        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);
     }
 
     /**
      * Process the Inbound RTP Audio and Video Data
      * @param stat - inbound rtp stats
      */
-    handleInBoundRTP(stat: InboundRTPStats) {
+    handleInboundRTP(stat: InboundRTPStats) {
         switch (stat.kind) {
             case 'video':
                 // Calculate bitrate between stat updates
@@ -216,25 +222,63 @@ export class AggregatedStats {
     }
 
     /**
-     * Process the outbound RTP Audio and Video Data
-     * @param stat - remote outbound stats
+     * Process the "local" outbound RTP Audio and Video stats.
+     * @param stat - local outbound rtp stats
      */
-    handleRemoteOutBound(stat: OutBoundRTPStats) {
-        switch (stat.kind) {
-            case 'video':
-                this.outBoundVideoStats.bytesSent = stat.bytesSent;
-                this.outBoundVideoStats.id = stat.id;
-                this.outBoundVideoStats.localId = stat.localId;
-                this.outBoundVideoStats.packetsSent = stat.packetsSent;
-                this.outBoundVideoStats.remoteTimestamp = stat.remoteTimestamp;
-                this.outBoundVideoStats.timestamp = stat.timestamp;
-                break;
-            case 'audio':
-                break;
+    handleLocalOutbound(stat: OutboundRTPStats) {
+        const localOutboundStats: OutboundRTPStats =
+            stat.kind === 'audio' ? this.outboundAudioStats : this.outboundVideoStats;
+        localOutboundStats.active = stat.active;
+        localOutboundStats.codecId = stat.codecId;
+        localOutboundStats.bytesSent = stat.bytesSent;
+        localOutboundStats.frameHeight = stat.frameHeight;
+        localOutboundStats.frameWidth = stat.frameWidth;
+        localOutboundStats.framesEncoded = stat.framesEncoded;
+        localOutboundStats.framesPerSecond = stat.framesPerSecond;
+        localOutboundStats.headerBytesSent = stat.headerBytesSent;
+        localOutboundStats.id = stat.id;
+        localOutboundStats.keyFramesEncoded = stat.keyFramesEncoded;
+        localOutboundStats.kind = stat.kind;
+        localOutboundStats.mediaSourceId = stat.mediaSourceId;
+        localOutboundStats.mid = stat.mid;
+        localOutboundStats.nackCount = stat.nackCount;
+        localOutboundStats.packetsSent = stat.packetsSent;
+        localOutboundStats.qpSum = stat.qpSum;
+        localOutboundStats.qualityLimitationDurations = stat.qualityLimitationDurations;
+        localOutboundStats.qualityLimitationReason = stat.qualityLimitationReason;
+        localOutboundStats.remoteId = stat.remoteId;
+        localOutboundStats.retransmittedBytesSent = stat.retransmittedBytesSent;
+        localOutboundStats.rid = stat.rid;
+        localOutboundStats.scalabilityMode = stat.scalabilityMode;
+        localOutboundStats.ssrc = stat.ssrc;
+        localOutboundStats.targetBitrate = stat.targetBitrate;
+        localOutboundStats.timestamp = stat.timestamp;
+        localOutboundStats.totalEncodeTime = stat.totalEncodeTime;
+        localOutboundStats.totalEncodeBytesTarget = stat.totalEncodeBytesTarget;
+        localOutboundStats.totalPacketSendDelay = stat.totalPacketSendDelay;
+        localOutboundStats.transportId = stat.transportId;
+    }
 
-            default:
-                break;
-        }
+    /**
+     * Process the "remote" outbound RTP Audio and Video stats.
+     * @param stat - remote outbound rtp stats
+     */
+    handleRemoteOutbound(stat: RemoteOutboundRTPStats) {
+        const remoteOutboundStats: RemoteOutboundRTPStats =
+            stat.kind === 'audio' ? this.remoteOutboundAudioStats : this.remoteOutboundVideoStats;
+        remoteOutboundStats.bytesSent = stat.bytesSent;
+        remoteOutboundStats.codecId = stat.codecId;
+        remoteOutboundStats.id = stat.id;
+        remoteOutboundStats.kind = stat.kind;
+        remoteOutboundStats.localId = stat.localId;
+        remoteOutboundStats.packetsSent = stat.packetsSent;
+        remoteOutboundStats.remoteTimestamp = stat.remoteTimestamp;
+        remoteOutboundStats.reportsSent = stat.reportsSent;
+        remoteOutboundStats.roundTripTimeMeasurements = stat.roundTripTimeMeasurements;
+        remoteOutboundStats.ssrc = stat.ssrc;
+        remoteOutboundStats.timestamp = stat.timestamp;
+        remoteOutboundStats.totalRoundTripTime = stat.totalRoundTripTime;
+        remoteOutboundStats.transportId = stat.transportId;
     }
 
     /**
@@ -288,16 +332,31 @@ export class AggregatedStats {
      * @returns The candidate pair that is currently receiving data
      */
     public getActiveCandidatePair(): CandidatePairStats | null {
+        if (this.candidatePairs === undefined) {
+            return 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
+            const selectedPair: CandidatePairStats | undefined = this.candidatePairs.find(
+                (candidatePair) => candidatePair.id === this.transportStats.selectedCandidatePairId
             );
+            if (selectedPair === undefined) {
+                return null;
+            } else {
+                return selectedPair;
+            }
         }
 
-        // Fall back to the selected candidate pair
-        return this.candidatePairs.find((candidatePair) => candidatePair.selected, null);
+        // Fall back to the `.selected` member of the candidate pair
+        const selectedPair: CandidatePairStats | undefined = this.candidatePairs.find(
+            (candidatePair) => candidatePair.selected
+        );
+        if (selectedPair === undefined) {
+            return null;
+        } else {
+            return selectedPair;
+        }
     }
 }

package/src/PeerConnectionController/InboundRTPStats.ts

@@ -4,41 +4,41 @@
  * Inbound Audio Stats collected from the RTC Stats Report
  */
 export class InboundAudioStats {
-    audioLevel: number;
+    audioLevel: number | undefined;
     bytesReceived: number;
     codecId: string;
-    concealedSamples: number;
-    concealmentEvents: number;
-    fecPacketsDiscarded: number;
-    fecPacketsReceived: number;
+    concealedSamples: number | undefined;
+    concealmentEvents: number | undefined;
+    fecPacketsDiscarded: number | undefined;
+    fecPacketsReceived: number | undefined;
     headerBytesReceived: number;
     id: string;
-    insertedSamplesForDeceleration: number;
+    insertedSamplesForDeceleration: number | undefined;
     jitter: number;
     jitterBufferDelay: number;
     jitterBufferEmittedCount: number;
-    jitterBufferMinimumDelay: number;
-    jitterBufferTargetDelay: number;
+    jitterBufferMinimumDelay: number | undefined;
+    jitterBufferTargetDelay: number | undefined;
     kind: string;
     lastPacketReceivedTimestamp: number;
-    mediaType: string;
+    mediaType: string | undefined;
     mid: string;
-    packetsDiscarded: number;
+    packetsDiscarded: number | undefined;
     packetsLost: number;
     packetsReceived: number;
-    removedSamplesForAcceleration: number;
-    silentConcealedSamples: number;
+    removedSamplesForAcceleration: number | undefined;
+    silentConcealedSamples: number | undefined;
     ssrc: number;
     timestamp: number;
-    totalAudioEnergy: number;
-    totalSamplesDuration: number;
-    totalSamplesReceived: number;
-    trackIdentifier: string;
-    transportId: string;
+    totalAudioEnergy: number | undefined;
+    totalSamplesDuration: number | undefined;
+    totalSamplesReceived: number | undefined;
+    trackIdentifier: string | undefined;
+    transportId: string | undefined;
     type: string;
 
     /* additional, custom stats */
-    bitrate: number;
+    bitrate: number | undefined;
 }
 
 /**
@@ -46,47 +46,47 @@ export class InboundAudioStats {
  */
 export class InboundVideoStats {
     bytesReceived: number;
-    codecId: string;
-    firCount: number;
-    frameHeight: number;
-    frameWidth: number;
-    framesAssembledFromMultiplePackets: number;
-    framesDecoded: number;
-    framesDropped: number;
-    framesPerSecond: number;
-    framesReceived: number;
-    freezeCount: number;
-    googTimingFrameInfo: string;
+    codecId: string | undefined;
+    firCount: number | undefined;
+    frameHeight: number | undefined;
+    frameWidth: number | undefined;
+    framesAssembledFromMultiplePackets: number | undefined;
+    framesDecoded: number | undefined;
+    framesDropped: number | undefined;
+    framesPerSecond: number | undefined;
+    framesReceived: number | undefined;
+    freezeCount: number | undefined;
+    googTimingFrameInfo: string | undefined;
     headerBytesReceived: number;
     id: string;
     jitter: number;
     jitterBufferDelay: number;
     jitterBufferEmittedCount: number;
-    keyFramesDecoded: number;
+    keyFramesDecoded: number | undefined;
     kind: string;
-    lastPacketReceivedTimestamp: number;
-    mediaType: string;
+    lastPacketReceivedTimestamp: number | undefined;
+    mediaType: string | undefined;
     mid: string;
-    nackCount: number;
+    nackCount: number | undefined;
     packetsLost: number;
     packetsReceived: number;
-    pauseCount: number;
-    pliCount: number;
+    pauseCount: number | undefined;
+    pliCount: number | undefined;
     ssrc: number;
     timestamp: number;
-    totalAssemblyTime: number;
-    totalDecodeTime: number;
-    totalFreezesDuration: number;
-    totalInterFrameDelay: number;
-    totalPausesDuration: number;
-    totalProcessingDelay: number;
-    totalSquaredInterFrameDelay: number;
-    trackIdentifier: string;
-    transportId: string;
+    totalAssemblyTime: number | undefined;
+    totalDecodeTime: number | undefined;
+    totalFreezesDuration: number | undefined;
+    totalInterFrameDelay: number | undefined;
+    totalPausesDuration: number | undefined;
+    totalProcessingDelay: number | undefined;
+    totalSquaredInterFrameDelay: number | undefined;
+    trackIdentifier: string | undefined;
+    transportId: string | undefined;
     type: string;
 
     /* additional, custom stats */
-    bitrate: number;
+    bitrate: number | undefined;
 }
 
 /**
@@ -95,60 +95,63 @@ export class InboundVideoStats {
 export class InboundRTPStats {
     /* common stats */
     bytesReceived: number;
-    codecId: string;
+    codecId: string | undefined;
     headerBytesReceived: number;
     id: string;
     jitter: number;
     jitterBufferDelay: number;
     jitterBufferEmittedCount: number;
     kind: string;
-    lastPacketReceivedTimestamp: number;
-    mediaType: string;
+    lastPacketReceivedTimestamp: number | undefined;
+    mediaType: string | undefined;
     mid: string;
     packetsLost: number;
     packetsReceived: number;
+    playoutId: string | undefined;
+    qpsum: number | undefined;
+    remoteId: string | undefined;
     ssrc: number;
     timestamp: number;
-    trackIdentifier: string;
-    transportId: string;
+    trackIdentifier: string | undefined;
+    transportId: string | undefined;
     type: string;
 
     /* audio specific stats */
-    audioLevel: number;
-    concealedSamples: number;
-    concealmentEvents: number;
-    fecPacketsDiscarded: number;
-    fecPacketsReceived: number;
-    insertedSamplesForDeceleration: number;
-    jitterBufferMinimumDelay: number;
-    jitterBufferTargetDelay: number;
-    packetsDiscarded: number;
-    removedSamplesForAcceleration: number;
-    silentConcealedSamples: number;
-    totalAudioEnergy: number;
-    totalSamplesDuration: number;
-    totalSamplesReceived: number;
+    audioLevel: number | undefined;
+    concealedSamples: number | undefined;
+    concealmentEvents: number | undefined;
+    fecPacketsDiscarded: number | undefined;
+    fecPacketsReceived: number | undefined;
+    insertedSamplesForDeceleration: number | undefined;
+    jitterBufferMinimumDelay: number | undefined;
+    jitterBufferTargetDelay: number | undefined;
+    packetsDiscarded: number | undefined;
+    removedSamplesForAcceleration: number | undefined;
+    silentConcealedSamples: number | undefined;
+    totalAudioEnergy: number | undefined;
+    totalSamplesDuration: number | undefined;
+    totalSamplesReceived: number | undefined;
 
     /* video specific stats */
-    firCount: number;
-    frameHeight: number;
-    frameWidth: number;
-    framesAssembledFromMultiplePackets: number;
-    framesDecoded: number;
-    framesDropped: number;
-    framesPerSecond: number;
-    framesReceived: number;
-    freezeCount: number;
-    googTimingFrameInfo: string;
-    keyFramesDecoded: number;
-    nackCount: number;
-    pauseCount: number;
-    pliCount: number;
-    totalAssemblyTime: number;
-    totalDecodeTime: number;
-    totalFreezesDuration: number;
-    totalInterFrameDelay: number;
-    totalPausesDuration: number;
-    totalProcessingDelay: number;
-    totalSquaredInterFrameDelay: number;
+    firCount: number | undefined;
+    frameHeight: number | undefined;
+    frameWidth: number | undefined;
+    framesAssembledFromMultiplePackets: number | undefined;
+    framesDecoded: number | undefined;
+    framesDropped: number | undefined;
+    framesPerSecond: number | undefined;
+    framesReceived: number | undefined;
+    freezeCount: number | undefined;
+    googTimingFrameInfo: string | undefined;
+    keyFramesDecoded: number | undefined;
+    nackCount: number | undefined;
+    pauseCount: number | undefined;
+    pliCount: number | undefined;
+    totalAssemblyTime: number | undefined;
+    totalDecodeTime: number | undefined;
+    totalFreezesDuration: number | undefined;
+    totalInterFrameDelay: number | undefined;
+    totalPausesDuration: number | undefined;
+    totalProcessingDelay: number | undefined;
+    totalSquaredInterFrameDelay: number | undefined;
 }