Add getRTCStatsReport method to local and remote track classes (#826)

* Add getRTCStatsReport method to local and remote track classes * Use optional chaining in getRTCStatsReport methods
livekit · Sep 14, 2023 · 20ffe01 · 20ffe01
1 parent ad285af
commit 20ffe01
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/src/room/track/LocalTrack.ts b/src/room/track/LocalTrack.ts
@@ -372,6 +372,20 @@ export default abstract class LocalTrack extends Track {
     }
   }
 
+  /**
+   * Gets the RTCStatsReport for the LocalTrack's underlying RTCRtpSender
+   * See https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport
+   *
+   * @returns Promise<RTCStatsReport> | undefined
+   */
+  async getRTCStatsReport(): Promise<RTCStatsReport | undefined> {
+    if (!this.sender?.getStats) {
+      return;
+    }
+    const statsReport = await this.sender.getStats();
+    return statsReport;
+  }
+
   /**
    * Sets a processor on this track.
    * See https://github.com/livekit/track-processors-js for example usage

diff --git a/src/room/track/RemoteTrack.ts b/src/room/track/RemoteTrack.ts
@@ -51,6 +51,20 @@ export default abstract class RemoteTrack extends Track {
     super.disable();
   }
 
+  /**
+   * Gets the RTCStatsReport for the RemoteTrack's underlying RTCRtpReceiver
+   * See https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport
+   *
+   * @returns Promise<RTCStatsReport> | undefined
+   */
+  async getRTCStatsReport(): Promise<RTCStatsReport | undefined> {
+    if (!this.receiver?.getStats) {
+      return;
+    }
+    const statsReport = await this.receiver.getStats();
+    return statsReport;
+  }
+
   /* @internal */
   startMonitor() {
     if (!this.monitorInterval) {