Class LiveKitParticipantService

Changes participants in live LiveKit rooms, on the server's authority.

Index

Constructors

Methods

Constructors

constructor

new LiveKitParticipantService(
config?: Partial<LiveKitServerConfig>,
client?: ParticipantUpdateClientLike,
): LiveKitParticipantService
Parameters
- Optionalconfig: Partial<LiveKitServerConfig>
  Explicit credentials; omitted fields fall back to environment variables (via LiveKitTokenService). The room service client uses the HTTP(S) form of the server URL.
- Optionalclient: ParticipantUpdateClientLike
  An injectable room service client (primarily for unit testing); defaults to a real RoomServiceClient built from the resolved credentials.
Returns LiveKitParticipantService
- Defined in LiveKitRoomServer/src/livekit-participant-service.ts:40

Methods

SetAgentVision

SetAgentVision(
    roomName: string,
    identity: string,
    allow: boolean,
): Promise<ParticipantUpdateResult>
Records whether a person lets agents see their camera and shared screen: sets their mj.agentCanSee attribute to 'true', or removes it. The caller must already have established that identity is the person asking.
Parameters
- roomName: string
  The room the person is in.
- identity: string
  The person's participant identity.
- allow: boolean
  true to let agents see, false to stop.
Returns Promise<ParticipantUpdateResult>
Whether LiveKit applied it; never throws.
- Defined in LiveKitRoomServer/src/livekit-participant-service.ts:56