SFU and SDKs for high-performance, scalable WebRTC
LiveKit: Real-time video, audio and data for developers
LiveKit is an open source project that provides scalable, multi-user conferencing based on WebRTC. It's designed to provide everything you need to build real-time video audio data capabilities in your applications.
LiveKit's server is written in Go, using the awesome Pion WebRTC implementation.
Features
Live Demos
SDKs & Tools Client SDKs
Client SDKs enable your frontend to include interactive, multi-user experiences.
Language
Repo
<a href="https://docs.livekit.io/guides/room/events/#declarative-ui" rel="nofollow">Declarative UI</a>
Links
JavaScript (TypeScript)
<a href="https://github.com/livekit/client-sdk-js" rel="nofollow">client-sdk-js</a>
<a href="https://github.com/livekit/livekit-react" rel="nofollow">React</a>
<a href="https://docs.livekit.io/client-sdk-js/" rel="nofollow">docs</a>
|
<a href="https://github.com/livekit/client-sdk-js/tree/main/example" rel="nofollow">JS example</a>
|
<a href="https://github.com/livekit/client-sdk-js/tree/main/example" rel="nofollow">React example</a>
Swift (iOS / MacOS)
<a href="https://github.com/livekit/client-sdk-swift" rel="nofollow">client-sdk-swift</a>
Swift UI
<a href="https://docs.livekit.io/client-sdk-swift/" rel="nofollow">docs</a>
|
<a href="https://github.com/livekit/client-example-swift" rel="nofollow">example</a>
Kotlin (Android)
<a href="https://github.com/livekit/client-sdk-android" rel="nofollow">client-sdk-android</a>
Compose
<a href="https://docs.livekit.io/client-sdk-android/index.html" rel="nofollow">docs</a>
|
<a href="https://github.com/livekit/client-sdk-android/tree/main/sample-app/src/main/java/io/livekit/android/sample" rel="nofollow">example</a>
|
<a href="https://github.com/livekit/client-sdk-android/tree/main/sample-app-compose/src/main/java/io/livekit/android/composesample" rel="nofollow">Compose example</a>
Flutter (all platforms)
<a href="https://github.com/livekit/client-sdk-flutter" rel="nofollow">client-sdk-flutter</a>
native
<a href="https://docs.livekit.io/client-sdk-flutter/" rel="nofollow">docs</a>
|
<a href="https://github.com/livekit/client-sdk-flutter/tree/main/example" rel="nofollow">example</a>
Unity WebGL
<a href="https://github.com/livekit/client-sdk-unity-web" rel="nofollow">client-sdk-unity-web</a>
<a href="https://livekit.github.io/client-sdk-unity-web/" rel="nofollow">docs</a>
React Native (beta)
<a href="https://github.com/livekit/client-sdk-react-native" rel="nofollow">client-sdk-react-native</a>
native
Rust
<a href="https://github.com/livekit/client-sdk-rust" rel="nofollow">client-sdk-rust</a>
Server SDKs
Server SDKs enable your backend to generate access tokens, call server APIs, and receive webhooks. In addition, the Go SDK includes client capabilities, enabling you to build automations that behave like end-users.
Language Repo Docs
JavaScript (TypeScript) server-sdk-js docs
Ruby server-sdk-ruby
Java (Kotlin) server-sdk-kotlin
Python (community) tradablebits/livekit-server-sdk-python
PHP (community) agence104/livekit-server-sdk-php
Ecosystem & Tools
Install
We recommend installing livekit-cli along with the server. It lets you access server APIs, create tokens, and generate test traffic.
MacOS
brew install livekitLinux
curl -sSL https://get.livekit.io | bashWindows
Download the latest release here
Getting Started Starting LiveKit
Start LiveKit in development mode by running livekit-server --dev
. It'll use a placeholder API key/secret pair.
API Key: devkey
API Secret: secret
To customize your setup for production, refer to our deployment docs
Creating access token
A user connecting to a LiveKit room requires an access token. Access tokens (JWT) encode the user's identity and the room permissions they've been granted. You can generate a token with our CLI:
livekit-cli create-token \ --api-key devkey --api-secret secret \ --join --room my-first-room --identity user1 \ --valid-for 24hTest with example app
Head over to our example app and enter a generated token to connect to your LiveKit server. This app is built with our React SDK.
Once connected, your video and audio are now being published to your new LiveKit instance!
Simulating a test publisher
livekit-cli join-room \ --url ws://localhost:7880 \ --api-key devkey --api-secret secret \ --room my-first-room --identity bot-user1 \ --publish-demo
This command publishes a looped demo video to a room. Due to how the video clip was encoded (keyframes every 3s), there's a slight delay before the browser has sufficient data to begin rendering frames. This is an artifact of the simulation.
Deployment Use LiveKit Cloud
LiveKit Cloud is the fastest and most reliable way to run LiveKit. Every project gets free monthly bandwidth and transcoding credits.
Sign up for LiveKit Cloud.
Self-host
Read our deployment docs for more information.
Building from source
Pre-requisites:
Then run
git clone https://github.com/livekit/livekit cd livekit ./bootstrap.sh mageContributing
We welcome your contributions toward improving LiveKit! Please join us on Slack to discuss your ideas and/or PRs.
License
LiveKit server is licensed under Apache License v2.0.
LiveKit Ecosystem
Client SDKs
Components · JavaScript · iOS/macOS · Android · Flutter · React Native · Rust · Python · Unity (web) · Unity (beta)
Server SDKs
Node.js · Golang · Ruby · Java/Kotlin · PHP (community) · Python (community)
Services
Livekit server · Egress · Ingress
Resources
Docs · Example apps · Cloud · Self-hosting · CLI
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.