Type Alias: IssueParticipantTokenRequest
Properties
| Property | Type | Required | Description |
|---|---|---|---|
externalUserId | string | Yes | The game's own user identifier of the player. The participant is created on first use. (example: "steam:76561198000000000") |
displayName | string | No | Display name to store on the participant (updated when it changed). (example: "Alice") |
gatheringId | string | No | Bind the token to a gathering. The client may then read that gathering and mark itself ready, and only sees transcripts of the session this gathering started. (example: "0f4a7c1e-6a5b-4f28-9f7e-2b1d6b3c9a10") |
roomId | string | No | Bind the token to an ODIN room. When set, an ODIN voice token for that room is issued alongside the participant token, saving the client a second round trip. (example: "boss-room-lobby-17") |
ttlSeconds | number | No | Requested lifetime in seconds. Clamped to 900 (the maximum and the default). (example: 300) |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/participants.ts:24