LiveKit

WebRTC 端到端堆栈。SFU 媒体服务器和 SDK。「End-to-end stack for WebRTC. SFU media server and SDKs.」

Github星跟蹤圖

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.

GitHub stars
Slack community
Twitter Follow
GitHub release (latest SemVer)
GitHub Workflow Status
License

Features

Documentation & Guides

https://docs.livekit.io

Live Demos

SDKs & Tools

Client SDKs

Client SDKs enable your frontend to include interactive, multi-user experiences.

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
Go server-sdk-go 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 livekit

Linux

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

Windows

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 24h

Test 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:

  • Go 1.20+ is installed
  • GOPATH/bin is in your PATH

Then run

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

Contributing

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/livekit
主編程語言Go
編程語言 (語言數: 3)
平台
許可證Apache License 2.0
發布數121
最新版本名稱v1.6.1 (發布於 )
第一版名稱v0.0.1 (發布於 )
創建於2020-09-30 06:49:46
推送於2024-05-15 21:01:17
最后一次提交2024-05-15 11:41:37
星數7.5k
關注者數106
派生數622
提交數2.6k
已啟用問題?
問題數455
打開的問題數90
拉請求數2087
打開的拉請求數11
關閉的拉請求數136
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?
去到頂部