Class AccessToken

constructor

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

  Creates a new AccessToken

  Parameters

  • OptionalapiKey: string

    API Key, can be set in env LIVEKIT_API_KEY
  • OptionalapiSecret: string

    Secret, can be set in env LIVEKIT_API_SECRET
  • Optionaloptions: AccessTokenOptions

  Returns AccessToken

Optionalidentity

ttl

attributes

• get attributes(): undefined | Record<string, string>

  Returns undefined | Record<string, string>

• set attributes(attrs: Record<string, string>): void

  Parameters

  • attrs: Record<string, string>

  Returns void

kind

• get kind(): undefined | string

  Returns undefined | string

• set kind(kind: string): void

  Parameters

  • kind: string

  Returns void

metadata

• get metadata(): undefined | string

  Returns undefined | string

• set metadata(md: string): void

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

  Parameters

  • md: string

  Returns void

name

• get name(): undefined | string

  Returns undefined | string

• set name(name: string): void

  Parameters

  • name: string

  Returns void

roomConfig

• get roomConfig(): undefined | RoomConfiguration

  Returns undefined | RoomConfiguration

• set roomConfig(config: undefined | RoomConfiguration): void

  Parameters

  • config: undefined | RoomConfiguration

  Returns void

roomPreset

• get roomPreset(): undefined | string

  Returns undefined | string

• set roomPreset(preset: undefined | string): void

  Parameters

  • preset: undefined | string

  Returns void

sha256

• get sha256(): undefined | string

  Returns undefined | string

• set sha256(sha: undefined | string): void

  Parameters

  • sha: undefined | string

  Returns void

addGrant

• addGrant(grant: VideoGrant): void

  Adds a video grant to this token.

  Parameters

  • grant: VideoGrant

  Returns void

addInferenceGrant

• addInferenceGrant(grant: InferenceGrant): void

  Adds an inference grant to this token.

  Parameters

  • grant: InferenceGrant

  Returns void

addSIPGrant

• addSIPGrant(grant: SIPGrant): void

  Adds a SIP grant to this token.

  Parameters

  • grant: SIPGrant

  Returns void

toJwt

• toJwt(): Promise<string>

  Returns Promise<string>

  JWT encoded token