Add metrics support (#1278)

* add metrics support

* update protocol

* fix import

* Create fifty-dogs-camp.md

.changeset/fifty-dogs-camp.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Add metrics support

package.json

@@ -53,7 +53,7 @@
     "size-limit": "size-limit"
   },
   "dependencies": {
-    "@livekit/protocol": "1.23.0",
+    "@livekit/protocol": "1.24.0",
     "events": "^3.3.0",
     "loglevel": "^1.8.0",
     "sdp-transform": "^2.14.1",

src/room/Room.ts

@@ -7,6 +7,7 @@ import {
   JoinResponse,
   LeaveRequest,
   LeaveRequest_Action,
+  MetricsBatch,
   ParticipantInfo,
   ParticipantInfo_State,
   ParticipantPermission,
@@ -1546,6 +1547,8 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       this.handleSipDtmf(participant, packet.value.value);
     } else if (packet.value.case === 'chatMessage') {
       this.handleChatMessage(participant, packet.value.value);
+    } else if (packet.value.case === 'metrics') {
+      this.handleMetrics(packet.value.value, participant);
     }
   };
 
@@ -1595,6 +1598,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     this.emit(RoomEvent.ChatMessage, msg, participant);
   };
 
+  private handleMetrics = (metrics: MetricsBatch, participant?: Participant) => {
+    this.emit(RoomEvent.MetricsReceived, metrics, participant);
+  };
+
   private handleAudioPlaybackStarted = () => {
     if (this.canPlaybackAudio) {
       return;
@@ -2295,4 +2302,5 @@ export type RoomEventCallbacks = {
   activeDeviceChanged: (kind: MediaDeviceKind, deviceId: string) => void;
   chatMessage: (message: ChatMessage, participant?: RemoteParticipant | LocalParticipant) => void;
   localTrackSubscribed: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
+  metricsReceived: (metrics: MetricsBatch, participant?: Participant) => void;
 };

src/room/events.ts

@@ -330,6 +330,11 @@ export enum RoomEvent {
    * fired when the first remote participant has subscribed to the localParticipant's track
    */
   LocalTrackSubscribed = 'localTrackSubscribed',
+
+  /**
+   * fired when the client receives connection metrics from other participants
+   */
+  MetricsReceived = 'metricsReceived',
 }
 
 export enum ParticipantEvent {