Room.isRecording to surface if the room is being recorded (#412)

* Room.isRecording to surface if the room is being recorded.

* changeset

* use getter pattern

* add recording event

Co-authored-by: Lukas <[email protected]>

Author: davidzhao

.changeset/kind-roses-live.md

@@ -0,0 +1,5 @@
+---
+'livekit-client': patch
+---
+
+Expose Room.isRecording to indicate if the Room is being recorded

src/room/Room.ts

@@ -101,6 +101,8 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   /** options of room */
   options: InternalRoomOptions;
 
+  private _isRecording: boolean = false;
+
   private identityToSid: Map<string, string>;
 
   /** connect options of room */
@@ -332,6 +334,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         this.name = joinResponse.room!.name;
         this.sid = joinResponse.room!.sid;
         this.metadata = joinResponse.room!.metadata;
+        if (this._isRecording !== joinResponse.room!.activeRecording) {
+          this._isRecording = joinResponse.room!.activeRecording;
+          this.emit(RoomEvent.RecordingStatusChanged, joinResponse.room!.activeRecording);
+        }
         this.emit(RoomEvent.SignalConnected);
       } catch (err) {
         this.recreateEngine();
@@ -424,6 +430,13 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     this.connectFuture = undefined;
   }
 
+  /**
+   * if the current room has a participant with `recorder: true` in its JWT grant
+   **/
+  get isRecording() {
+    return this._isRecording;
+  }
+
   /**
    * @internal for testing
    */
@@ -951,6 +964,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
 
   private handleRoomUpdate = (r: RoomModel) => {
     this.metadata = r.metadata;
+    if (this._isRecording !== r.activeRecording) {
+      this._isRecording = r.activeRecording;
+      this.emit(RoomEvent.RecordingStatusChanged, r.activeRecording);
+    }
     this.emitWhenConnected(RoomEvent.RoomMetadataChanged, r.metadata);
   };
 
@@ -1273,4 +1290,5 @@ export type RoomEventCallbacks = {
   ) => void;
   audioPlaybackChanged: (playing: boolean) => void;
   signalConnected: () => void;
+  recordingStatusChanged: (recording: boolean) => void;
 };

src/room/events.ts

@@ -250,6 +250,11 @@ export enum RoomEvent {
    * Signal connected, can publish tracks.
    */
   SignalConnected = 'signalConnected',
+
+  /**
+   * Recording of a room has started/stopped.
+   */
+  RecordingStatusChanged = 'recordingStatusChanged',
 }
 
 export enum ParticipantEvent {