Skip to content

feat: add a LiveKit client module (webrtc-livekit) - #603

Closed
devopvoid wants to merge 5 commits into
mainfrom
feat/livekit-spike
Closed

devopvoid wants to merge 5 commits into
mainfrom
feat/livekit-spike

Conversation

@devopvoid

Copy link
Copy Markdown
Owner

Description

A new module, webrtc-java-livekit (webrtc.java.livekit), joins rooms of a LiveKit server on top of the client API:

  • LiveKit.room(rtc, url, token).connect() joins a room, with participants, their join and leave events, and the tracks they publish.
  • Room.publish(...) publishes local tracks, video optionally in simulcast with LiveKit's layers and dynacast.
  • Room.publishData(...) and onData send and receive reliable or lossy data by topic.
  • Lost connections are resumed, or the room joins anew and publishes its tracks again.
  • A guide (docs/guide/client/livekit.md) and LiveKitExample.

Motivation and Context

LiveKit is a widely used open source SFU. With this module a Java application can take part in its rooms without a browser, for example in lectures with many passive viewers and a few who speak.

Type of Change

  • New feature (feat)

Affected Modules

  • webrtc-livekit (new)
  • webrtc-examples
  • docs

Notes for Reviewers

  • Speaks LiveKit's signaling protocol 16, with a publisher and a subscriber peer. The protos come from livekit/protocol v1.54.1, and the module brings protobuf-java along.
  • The integration tests need a livekit-server --dev and run only with -Dlivekit.url=ws://localhost:7880, so CI skips them.
  • The guide marks the API as new, and lists what is not supported yet.

Joins a room over LiveKit's signaling with a publisher and a subscriber
peer, publishes and subscribes to tracks and exchanges data packets.
No simulcast, dynacast or reconnect yet.
Video goes out in LiveKit's q/h/f layers, the layers no subscriber wants
pause on the server's quality updates, and subscribers can request a layer.
A lost signaling connection, a failed peer, missed pings or the server's
leave resume the session with an ICE restart; a session the server cannot
resume is joined anew, with the tracks published again.
A handler added after connect() missed the tracks that arrived before it. Also tests publishing audio.
@devopvoid

Copy link
Copy Markdown
Owner Author

Closing without merging: the LiveKit client moves to a repository of its own, devopvoid/webrtc-java-livekit, which will be published once webrtc-java 1.0.2 is released.

@devopvoid devopvoid closed this Nov 20, 2026
@devopvoid
devopvoid deleted the feat/livekit-spike branch November 20, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant