LiveKit Node SDKs

Use this SDK to add realtime video, audio and data features to your Node app. By connecting to LiveKit Cloud or a self-hosted server, you can quickly build applications such as multi-modal AI, live streaming, or video calls with just a few lines of code.

Monorepo Navigation

• Packages:
  • Server SDK - to interact with server APIs.
  • Node realtime SDK - to connect to LiveKit as a server-side participant, and to publish and subscribe to audio, video, and data.
• Examples
  • Webhooks HTTP (server SDK)
  • Webhooks NextJS (server SDK)
  • Publishing to a room (realtime SDK)

Development Setup

If you are interested in contributing to the project or running the examples that are part of this mono-repository, then you must first set up your development environment.

Setup Monorepo

This repo consists of multiple packages that partly build on top of each other. It relies on pnpm workspaces and Turborepo (which gets installed automatically).

Clone the repo and run pnpm install the root level:

pnpm install

In order to link up initial dependencies and check whether everything has installed correctly run

pnpm build

This will build all the packages in /packages and the examples in /examples once.

After that you can use a more granular command to only rebuild the packages you are working on.

Setup Submodules

Run the following command to install the submodules.

git submodule update --init --recursive

Then run pnpm build to make sure everything is up to date.