https://github.com/livekit/client-sdk-unity-web
Official LiveKit SDK for Unity WebGL
https://github.com/livekit/client-sdk-unity-web
metaverse unity unity3d video webgl webrtc
Last synced: 11 months ago
JSON representation
Official LiveKit SDK for Unity WebGL
- Host: GitHub
- URL: https://github.com/livekit/client-sdk-unity-web
- Owner: livekit
- License: apache-2.0
- Created: 2022-02-11T18:08:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-21T18:17:34.000Z (11 months ago)
- Last Synced: 2025-07-21T20:24:28.109Z (11 months ago)
- Topics: metaverse, unity, unity3d, video, webgl, webrtc
- Language: C#
- Homepage: https://livekit.io
- Size: 2.74 MB
- Stars: 70
- Watchers: 22
- Forks: 27
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LiveKit Unity SDK
Use this SDK to add realtime video, audio and data features to your Unity (WebGL) 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.
## Docs
Docs and guides at https://docs.livekit.io
[SDK reference](https://livekit.github.io/client-sdk-unity-web/)
## Installation :
Follow this [unity tutorial](https://docs.unity3d.com/Manual/upm-ui-giturl.html) using the `https://github.com/livekit/client-sdk-unity-web.git` link.
You can then directly import the samples into the package manager.
If you want to write JavaScript code in your application (e.g. you want to use React for your UI), you can install our [TypeScript package](https://www.npmjs.com/package/@livekit/livekit-unity) via npm.
To avoid confusion, the npm package and the Unity package will always have the same version number.
## Usage :
There are two different ways to build an application using this package :
1. Write your application entirely in C# (e.g. [ExampleRoom](https://github.com/livekit/client-sdk-unity-web/tree/main/Samples~/ExampleRoom))
2. Still use JS and be able to bridge the Room object by using our npm package. (e.g. [JSExample](https://github.com/livekit/client-sdk-unity-web/tree/main/Samples~/JSExample))
### Debugging
To display internal LiveKit logs, add LK DEBUG to define symbols
## Examples
For a complete example, look at our [demo](https://github.com/livekit/client-unity-demo)
### Connecting to a room
```cs
public class MyObject : MonoBehaviour
{
public Room Room;
IEnumerator Start()
{
Room = new Room();
var c = Room.Connect("", "");
yield return c;
if (!c.IsError) {
// Connected
}
}
}
```
### Publishing video & audio
```cs
yield return Room.LocalParticipant.EnableCameraAndMicrophone();
```
### Display a video on a RawImage
```cs
RawImage image = GetComponent();
Room.TrackSubscribed += (track, publication, participant) =>
{
if(track.Kind == TrackKind.Video)
{
var video = track.Attach() as HTMLVideoElement;
video.VideoReceived += tex =>
{
// VideoReceived is called every time the video resolution changes
image.texture = tex;
};
}
};
```
### Sending/Receiving data
```cs
Room.DataReceived += (data, participant, kind) =>
{
Debug.Log("Received data : " + Encoding.ASCII.GetString(data));
};
yield return Room.LocalParticipant.PublishData(Encoding.ASCII.GetBytes("This is as test"), DataPacketKind.RELIABLE);
```
LiveKit Ecosystem
LiveKit SDKsBrowser · iOS/macOS/visionOS · Android · Flutter · React Native · Rust · Node.js · Python · Unity · Unity (WebGL) · ESP32
Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community) · .NET (community)
UI ComponentsReact · Android Compose · SwiftUI · Flutter
Agents FrameworksPython · Node.js · Playground
ServicesLiveKit server · Egress · Ingress · SIP
ResourcesDocs · Example apps · Cloud · Self-hosting · CLI