<picture> <source media="(prefers-color-scheme: dark)" srcset="/.github/banner_dark.png"> <source media="(prefers-color-scheme: light)" srcset="/.github/banner_light.png"> <img style="width:100%;" alt="LiveKit图标、仓库名称以及背景中的示例代码。" src="https://raw.githubusercontent.com/livekit/livekit/main/.github/banner_light.png"> </picture>

LiveKit：为开发者提供实时视频、音频和数据

LiveKit是一个基于WebRTC的开源项目，提供可扩展的多用户会议功能。它旨在为您的应用程序提供构建实时视频音频数据功能所需的一切。

LiveKit的服务器使用Go语言编写，采用了出色的Pion WebRTC实现。

特性

可扩展的分布式WebRTC SFU（选择性转发单元）
现代、功能齐全的客户端SDK
为生产环境而构建，支持JWT认证
强大的网络和连接性，支持UDP/TCP/TURN
易于部署：单一二进制文件、Docker或Kubernetes
高级功能包括：
- 发言者检测
- 视频simulcast
- 端到端优化
- 选择性订阅
- 审核API
- 端到端加密
- SVC编解码器（VP9、AV1）
- webhooks
- 分布式和多区域

文档和指南

https://docs.livekit.io

在线演示

生态系统

Agents：使用可编程后端参与者构建实时多模态AI应用
Egress：录制或多流房间并导出单独的轨道
Ingress：从外部源（如RTMP、WHIP、HLS或OBS Studio）接收流

SDK和工具

客户端SDK

客户端SDK使您的前端能够包含交互式、多用户体验。

<table> <tr> <th>语言</th> <th>仓库</th> <th> <a href="https://docs.livekit.io/guides/room/events/#declarative-ui" target="_blank" rel="noopener noreferrer">声明式UI</a> </th> <th>链接</th> </tr> <tr> <td>JavaScript（TypeScript）</td> <td> <a href="https://github.com/livekit/client-sdk-js" target="_blank" rel="noopener noreferrer">client-sdk-js</a> </td> <td> <a href="https://github.com/livekit/livekit-react" target="_blank" rel="noopener noreferrer">React</a> </td> <td> <a href="https://docs.livekit.io/client-sdk-js/" target="_blank" rel="noopener noreferrer">文档</a> | <a href="https://github.com/livekit/client-sdk-js/tree/main/example" target="_blank" rel="noopener noreferrer">JS示例</a> | <a href="https://github.com/livekit/client-sdk-js/tree/main/example" target="_blank" rel="noopener noreferrer">React示例</a> </td> </tr> <tr> <td>Swift（iOS / MacOS）</td> <td> <a href="https://github.com/livekit/client-sdk-swift" target="_blank" rel="noopener noreferrer">client-sdk-swift</a> </td> <td>Swift UI</td> <td> <a href="https://docs.livekit.io/client-sdk-swift/" target="_blank" rel="noopener noreferrer">文档</a> | <a href="https://github.com/livekit/client-example-swift" target="_blank" rel="noopener noreferrer">示例</a> </td> </tr> <tr> <td>Kotlin（Android）</td> <td> <a href="https://github.com/livekit/client-sdk-android" target="_blank" rel="noopener noreferrer">client-sdk-android</a> </td> <td>Compose</td> <td> <a href="https://docs.livekit.io/client-sdk-android/index.html" target="_blank" rel="noopener noreferrer">文档</a> | <a href="https://github.com/livekit/client-sdk-android/tree/main/sample-app/src/main/java/io/livekit/android/sample" target="_blank" rel="noopener noreferrer">示例</a> | <a href="https://github.com/livekit/client-sdk-android/tree/main/sample-app-compose/src/main/java/io/livekit/android/composesample" target="_blank" rel="noopener noreferrer">Compose示例</a> </td> </tr> <tr> <td>Flutter（所有平台）</td> <td> <a href="https://github.com/livekit/client-sdk-flutter" target="_blank" rel="noopener noreferrer">client-sdk-flutter</a> </td> <td>原生</td> <td> <a href="https://docs.livekit.io/client-sdk-flutter/" target="_blank" rel="noopener noreferrer">文档</a> | <a href="https://github.com/livekit/client-sdk-flutter/tree/main/example" target="_blank" rel="noopener noreferrer">示例</a> </td> </tr> <tr> <td>Unity WebGL</td> <td> <a href="https://github.com/livekit/client-sdk-unity-web" target="_blank" rel="noopener noreferrer">client-sdk-unity-web</a> </td> <td></td> <td> <a href="https://livekit.github.io/client-sdk-unity-web/" target="_blank" rel="noopener noreferrer">文档</a> </td> </tr> <tr> <td>React Native（测试版）</td> <td> <a href="https://github.com/livekit/client-sdk-react-native" target="_blank" rel="noopener noreferrer">client-sdk-react-native</a> </td> <td>原生</td> <td></td> </tr> <tr> <td>Rust</td> <td> <a href="https://github.com/livekit/client-sdk-rust" target="_blank" rel="noopener noreferrer">client-sdk-rust</a> </td> <td></td> <td></td> </tr> </table>

服务器SDK

服务器SDK使您的后端能够生成访问令牌，调用服务器API，以及接收webhooks。此外，Go SDK包含客户端功能，使您能够构建像最终用户一样行为的自动化程序。

语言	仓库	文档
Go	server-sdk-go	文档
JavaScript（TypeScript）	server-sdk-js	文档
Ruby	server-sdk-ruby
Java（Kotlin）	server-sdk-kotlin
Python（社区）	python-sdks
PHP（社区）	agence104/livekit-server-sdk-php

工具

CLI - 命令行接口和负载测试器
Docker镜像
Helm charts

安装

[!提示] 我们建议与服务器一起安装LiveKit CLI。它允许您访问服务器API、创建令牌和生成测试流量。

以下将安装LiveKit的媒体服务器：

MacOS

brew install livekit

Linux

curl -sSL https://get.livekit.io | bash

Windows

在此处下载最新版本

入门

启动LiveKit

通过运行livekit-server --dev以开发模式启动LiveKit。它将使用一个占位符API密钥/密钥对。

API密钥：devkey
API密钥：secret

要为生产环境自定义设置，请参阅我们的部署文档

创建访问令牌

连接到LiveKit房间的用户需要一个访问令牌。访问令牌（JWT）编码了用户的身份和授予他们的房间权限。您可以使用我们的CLI生成令牌：

livekit-cli create-token \
    --api-key devkey --api-secret secret \
    --join --room my-first-room --identity user1 \
    --valid-for 24h

使用示例应用进行测试

前往我们的示例应用，输入生成的令牌以连接到您的LiveKit服务器。此应用使用我们的React SDK构建。

连接后，您的视频和音频现在正在发布到您的新LiveKit实例！

模拟测试发布者

livekit-cli join-room \
    --url ws://localhost:7880 \
    --api-key devkey --api-secret secret \
    --room my-first-room --identity bot-user1 \
    --publish-demo

此命令将循环演示视频发布到房间。由于视频剪辑的编码方式（每3秒一个关键帧），浏览器在获得足够数据开始渲染帧之前会有轻微延迟。这是模拟的一个特征。

部署

使用LiveKit Cloud

LiveKit Cloud是运行LiveKit最快速和最可靠的方式。每个项目都可以获得免费的月度带宽和转码额度。

注册LiveKit Cloud。

自托管

阅读我们的部署文档以获取更多信息。

从源代码构建

前提条件：

安装Go 1.22+
GOPATH/bin在你的PATH中

然后运行

git clone https://github.com/livekit/livekit
cd livekit
./bootstrap.sh
mage

贡献

我们欢迎您为改进LiveKit做出贡献！请加入我们的Slack群组讨论您的想法和/或PR。

许可证

LiveKit服务器采用Apache License v2.0许可。

<thead><tr><th colspan="2">LiveKit生态系统</th></tr></thead> <tbody> <tr><td>实时SDK</td><td><a href="https://github.com/livekit/components-js">React组件</a> · <a href="https://github.com/livekit/client-sdk-js">浏览器</a> · <a href="https://github.com/livekit/components-swift">Swift组件</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS/visionOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity（网页）</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity（测试版）</a></td></tr><tr></tr> <tr><td>服务器API</td><td><a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP（社区）</a></td></tr><tr></tr> <tr><td>代理框架</td><td><a href="https://github.com/livekit/agents">Python</a> · <a href="https://github.com/livekit/agent-playground">演练场</a></td></tr><tr></tr> <tr><td>服务</td><td><b>LiveKit服务器</b> · <a href="https://github.com/livekit/egress">出口</a> · <a href="https://github.com/livekit/ingress">入口</a> · <a href="https://github.com/livekit/sip">SIP</a></td></tr><tr></tr> <tr><td>资源</td><td><a href="https://docs.livekit.io">文档</a> · <a href="https://github.com/livekit-examples">示例应用</a> · <a href="https://livekit.io/cloud">云</a> · <a href="https://docs.livekit.io/home/self-hosting/deployment">自托管</a> · <a href="https://github.com/livekit/livekit-cli">CLI</a></td></tr> </tbody> </table>