Class AccessToken

constructor

• new AccessToken(apiKey?, apiSecret?, options?): AccessToken

• Creates a new AccessToken

  Parameters

  • Optional apiKey: string

    API Key, can be set in env LIVEKIT_API_KEY

  • Optional apiSecret: string

    Secret, can be set in env LIVEKIT_API_SECRET

  • Optional options: AccessTokenOptions

  Returns AccessToken

Optional identity

ttl

metadata

• set metadata(md): void

• Set metadata to be passed to the Participant, used only when joining the room

  Parameters

  • md: string

  Returns void

name

• set name(name): void

• Parameters

  • name: string

  Returns void

sha256

• get sha256(): undefined | string

• Returns undefined | string

• set sha256(sha): void

• Parameters

  • sha: undefined | string

  Returns void

addGrant

• addGrant(grant): void

• Adds a video grant to this token.

  Parameters

  • grant: VideoGrant

  Returns void

toJwt

• toJwt(): Promise<string>

• Returns Promise<string>

  JWT encoded token