Class LiveKitTokenService

Mints scoped LiveKit access tokens. Stateless apart from its resolved credentials.

Index

Constructors

Accessors

IsConfigured ServerUrl

Methods

AssertConfigured MintBotToken MintClientToken MintToken

Constructors

constructor

new LiveKitTokenService(
config?: Partial<LiveKitServerConfig>,
): LiveKitTokenService
Parameters
- Optionalconfig: Partial<LiveKitServerConfig>
  Explicit credentials; any omitted field falls back to the corresponding environment variable (LIVEKIT_URL, LIVEKIT_API_KEY, LIVEKIT_API_SECRET).
Returns LiveKitTokenService
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:89

Accessors

IsConfigured

get IsConfigured(): boolean
Whether the service has the credentials needed to mint tokens.

Returns boolean
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:98

ServerUrl

get ServerUrl(): string
The configured server URL (for callers that need to return it to clients).

Returns string
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:103

Methods

AssertConfigured

AssertConfigured(): void
Throws a clear error when credentials are missing. Public so a caller that must fail before doing costly work (the room coordinator, before it opens a model session) gets the same error minting would.

Returns void
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:175

MintBotToken

MintBotToken(
    roomName: string,
    identity: string,
    displayName?: string,
    attributes?: Record<string, string>,
): Promise<MintedToken>
Mints a token for the AGENT bot (publish + subscribe + data, agent role metadata so the UI badges it correctly, and leave to update its own attributes, so it can say when its avatar was taken down). The bridge passes this in its session Configuration.AccessToken.
Parameters
- roomName: string
  The room to join.
- identity: string
  The bot identity.
- OptionaldisplayName: string
  The bot display name.
- Optionalattributes: Record<string, string>
  Participant attributes the bot carries from the moment it joins (e.g. mj.agentWatches).
Returns Promise<MintedToken>
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:150

MintClientToken

MintClientToken(
    roomName: string,
    identity: string,
    displayName?: string,
    ttlSeconds?: number,
): Promise<MintedToken>
Mints a token for a HUMAN participant (publish + subscribe + data, participant role).
Parameters
- roomName: string
  The room to join.
- identity: string
  The participant identity.
- OptionaldisplayName: string
  The display name.
- OptionalttlSeconds: number
  Optional token lifetime.
Returns Promise<MintedToken>
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:136

MintToken

MintToken(params: MintTokenParams): Promise<MintedToken>
Mints an access token for the given parameters.
Parameters
- params: MintTokenParams
  The token parameters (room, identity, grants, role).
Returns Promise<MintedToken>
The minted token + connection coordinates.

Throws
when credentials are not configured.
- Defined in LiveKitRoomServer/src/livekit-token-service.ts:114