Class LiveKitEgressService

Starts/stops/lists LiveKit room recordings (composite egress).

Index

Constructors

Methods

ListActiveRecordings StartRoomRecording StopRecording

Constructors

constructor

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

Methods

ListActiveRecordings

ListActiveRecordings(roomName: string): Promise<RecordingInfo[]>
Lists active recordings for a room.
Parameters
- roomName: string
  The room to query.
Returns Promise<RecordingInfo[]>
The active recordings.
- Defined in LiveKitRoomServer/src/livekit-egress-service.ts:100

StartRoomRecording

StartRoomRecording(params: StartRecordingParams): Promise<RecordingInfo>
Starts a composite recording of a room.
Parameters
- params: StartRecordingParams
  The recording parameters.
Returns Promise<RecordingInfo>
The started recording info.
- Defined in LiveKitRoomServer/src/livekit-egress-service.ts:76

StopRecording

StopRecording(egressId: string): Promise<RecordingInfo>
Stops a recording.
Parameters
- egressId: string
  The egress id returned by StartRoomRecording.
Returns Promise<RecordingInfo>
The final recording info.
- Defined in LiveKitRoomServer/src/livekit-egress-service.ts:89