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(): Record<string, string> | undefined

  Returns Record<string, string> | undefined

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

  Parameters

  • attrs: Record<string, string>

  Returns void

kind

• get kind(): string | undefined

  Returns string | undefined

• set kind(kind: string): void

  Parameters

  • kind: string

  Returns void

metadata

• get metadata(): string | undefined

  Returns string | undefined

• 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(): string | undefined

  Returns string | undefined

• set name(name: string): void

  Parameters

  • name: string

  Returns void

roomConfig

• get roomConfig(): RoomConfiguration | undefined

  Returns RoomConfiguration | undefined

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

  Parameters

  • config: RoomConfiguration | undefined

  Returns void

roomPreset

• get roomPreset(): string | undefined

  Returns string | undefined

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

  Parameters

  • preset: string | undefined

  Returns void

sha256

• get sha256(): string | undefined

  Returns string | undefined

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

  Parameters

  • sha: string | undefined

  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

addObservabilityGrant

• addObservabilityGrant(grant: ObservabilityGrant): void

  Adds an observability grant to this token.

  Parameters

  • grant: ObservabilityGrant

  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