livekit / client-sdk-unity-web

Client SDK for Unity WebGL

LiveKit Unity SDK

Use this SDK to add real-time video, audio and data features to your Unity app. By connecting to a self- or cloud-hosted LiveKit server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code.

Docs

Docs and guides at https://docs.livekit.io

SDK reference

Installation :

Follow this unity tutorial 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 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)
2. Still use JS and be able to bridge the Room object by using our npm package. (e.g. JSExample)

Debugging

To display internal LiveKit logs, add LK DEBUG to define symbols

Examples

For a complete example, look at our demo

Connecting to a room

public class MyObject : MonoBehaviour
{
    public Room Room;

    IEnumerator Start()
    {
        Room = new Room();
        var c = Room.Connect("<livekit-url>", "<your-token>");
        yield return c;

        if (!c.IsError) {
            // Connected
        }
    }
}

Publishing video & audio

yield return Room.LocalParticipant.EnableCameraAndMicrophone();

Display a video on a RawImage

RawImage image = GetComponent<RawImage>();

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

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
Real-time SDKs	React Components · JavaScript · iOS/macOS · Android · Flutter · React Native · Rust · Python · Unity (web) · Unity (beta)
Server APIs	Node.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community)
Agents Frameworks	Python · Playground
Services	Livekit server · Egress · Ingress · SIP
Resources	Docs · Example apps · Cloud · Self-hosting · CLI