Add Agent class and utility methods for working with agents

example/sample.ts

@@ -30,7 +30,7 @@ import {
   supportsAV1,
   supportsVP9,
 } from '../src/index';
-import { ScalabilityMode } from '../src/room/track/options';
+import type { ScalabilityMode } from '../src/room/track/options';
 import type { SimulationScenario } from '../src/room/types';
 import { isSVCCodec } from '../src/room/utils';
 

src/index.ts

@@ -2,6 +2,7 @@ import { DataPacket_Kind, DisconnectReason, SubscriptionError } from '@livekit/p
 import { LogLevel, LoggerNames, getLogger, setLogExtension, setLogLevel } from './logger';
 import DefaultReconnectPolicy from './room/DefaultReconnectPolicy';
 import Room, { ConnectionState } from './room/Room';
+import Agent from './room/participant/Agent';
 import LocalParticipant from './room/participant/LocalParticipant';
 import Participant, { ConnectionQuality, ParticipantKind } from './room/participant/Participant';
 import type { ParticipantTrackPermission } from './room/participant/ParticipantTrackPermission';
@@ -30,6 +31,7 @@ import {
   createAudioAnalyser,
   getEmptyAudioStreamTrack,
   getEmptyVideoStreamTrack,
+  isAgent,
   isBrowserSupported,
   supportsAV1,
   supportsAdaptiveStream,
@@ -69,6 +71,7 @@ export {
   Participant,
   RemoteAudioTrack,
   RemoteParticipant,
+  Agent,
   ParticipantKind,
   RemoteTrack,
   RemoteTrackPublication,
@@ -89,6 +92,7 @@ export {
   supportsDynacast,
   supportsVP9,
   Mutex,
+  isAgent,
 };
 export type {
   AudioAnalyserOptions,

src/room/Room.ts

@@ -7,6 +7,7 @@ import {
   LeaveRequest,
   LeaveRequest_Action,
   ParticipantInfo,
+  ParticipantInfo_Kind,
   ParticipantInfo_State,
   ParticipantPermission,
   Room as RoomModel,
@@ -51,6 +52,7 @@ import {
 } from './defaults';
 import { ConnectionError, ConnectionErrorReason, UnsupportedServer } from './errors';
 import { EngineEvent, ParticipantEvent, RoomEvent, TrackEvent } from './events';
+import Agent from './participant/Agent';
 import LocalParticipant from './participant/LocalParticipant';
 import type Participant from './participant/Participant';
 import type { ConnectionQuality } from './participant/Participant';
@@ -73,6 +75,7 @@ import {
   createDummyVideoStreamTrack,
   extractTranscriptionSegments,
   getEmptyAudioStreamTrack,
+  isAgent,
   isBrowserSupported,
   isCloud,
   isReactNative,
@@ -773,6 +776,15 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     return this.remoteParticipants.get(identity);
   }
 
+  /**
+   * retrieves agents currently present in the room
+   */
+  getAgents() {
+    return Array.from(this.remoteParticipants.values()).filter((participant) =>
+      isAgent(participant),
+    ) as Array<Agent>;
+  }
+
   private clearConnectionFutures() {
     this.connectFuture = undefined;
   }
@@ -1628,10 +1640,16 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   private createParticipant(identity: string, info?: ParticipantInfo): RemoteParticipant {
     let participant: RemoteParticipant;
     if (info) {
-      participant = RemoteParticipant.fromParticipantInfo(this.engine.client, info, {
-        loggerContextCb: () => this.logContext,
-        loggerName: this.options.loggerName,
-      });
+      participant =
+        info.kind === ParticipantInfo_Kind.AGENT
+          ? Agent.fromParticipantInfo(this.engine.client, info, {
+              loggerContextCb: () => this.logContext,
+              loggerName: this.options.loggerName,
+            })
+          : RemoteParticipant.fromParticipantInfo(this.engine.client, info, {
+              loggerContextCb: () => this.logContext,
+              loggerName: this.options.loggerName,
+            });
     } else {
       participant = new RemoteParticipant(this.engine.client, '', identity, undefined, undefined, {
         loggerContextCb: () => this.logContext,

src/room/participant/Agent.ts

@@ -0,0 +1,26 @@
+import { ParticipantInfo, ParticipantInfo_Kind } from '@livekit/protocol';
+import type { SignalClient } from '../../api/SignalClient';
+import type { LoggerOptions } from '../types';
+import RemoteParticipant from './RemoteParticipant';
+
+export default class Agent extends RemoteParticipant {
+  constructor(
+    signalClient: SignalClient,
+    sid: string,
+    identity: string | undefined,
+    name: string | undefined,
+    metadata: string | undefined,
+    loggerOptions?: LoggerOptions,
+  ) {
+    super(signalClient, sid, identity, name, metadata, loggerOptions, ParticipantInfo_Kind.AGENT);
+  }
+
+  /** @internal */
+  static fromParticipantInfo(
+    signalClient: SignalClient,
+    pi: ParticipantInfo,
+    loggerOptions: LoggerOptions,
+  ): Agent {
+    return new Agent(signalClient, pi.sid, pi.identity, pi.name, pi.metadata, loggerOptions);
+  }
+}

src/room/utils.ts

@@ -1,6 +1,10 @@
 import { ClientInfo, ClientInfo_SDK, Transcription as TranscriptionModel } from '@livekit/protocol';
 import { getBrowser } from '../utils/browserParser';
 import { protocolVersion, version } from '../version';
+import type Agent from './participant/Agent';
+import type Participant from './participant/Participant';
+import { ParticipantKind } from './participant/Participant';
+import type RemoteParticipant from './participant/RemoteParticipant';
 import CriticalTimers from './timers';
 import type LocalAudioTrack from './track/LocalAudioTrack';
 import type RemoteAudioTrack from './track/RemoteAudioTrack';
@@ -544,3 +548,7 @@ export function extractTranscriptionSegments(
     };
   });
 }
+
+export function isAgent(participant: Participant | RemoteParticipant): participant is Agent {
+  return participant.kind === ParticipantKind.AGENT;
+}