JSPM

livekit-client

0.4.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 260208
  • Score
    100M100P100Q168434F
  • License MIT

JavaScript/TypeScript client SDK for LiveKit

Package Exports

  • livekit-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (livekit-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JavaScript/TypeScript client SDK for LiveKit

Demo

test/sample.ts contains a demo webapp that uses the SDK. To run it, do

yarn sample

Access Token

In order to connect to a room, you need to first create an access token. Access tokens are JWT tokens that contain information about the authorization. LiveKit tokens include the room and participant name, and should be created for each participant that joins the room.

Access tokens can be created with livekit-cli, that came with the server, or other LiveKit server SDKs.

./bin/livekit-cli create-token --join --r <room_name> --p <participant_name>

You still need to create the room on the server separately, token encapsulates only permission to access the room.