English | 简体中文
Java client SDK for LiveKit real-time communication platform.
- Room Management - Join/leave rooms, handle participants and tracks
- WebRTC Integration - Audio/video publishing and subscribing via webrtc-java
- Data Channels - Reliable and lossy data messaging
- E2EE - End-to-end encryption for data channels (AES-GCM with key ratcheting)
- Auto Reconnection - Automatic reconnection with exponential backoff
- Network Monitoring - Resume tokens and network change detection
- Java 21+
- Gradle 9.x (included via wrapper)
repositories {
mavenCentral()
maven { url = uri("https://jitpack.io") }
}
dependencies {
// Full SDK with WebRTC support
implementation("com.github.Trirrin.livekit-java-sdk:rtc:v0.1.0")
// Or signaling only (no audio/video)// implementation("com.github.Trirrin.livekit-java-sdk:signaling:v0.1.0")
}repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.Trirrin.livekit-java-sdk:rtc:v0.1.0'
}<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.github.Trirrin.livekit-java-sdk</groupId>
<artifactId>rtc</artifactId>
<version>v0.1.0</version>
</dependency>
</dependencies>importio.livekit.sdk.Room;
importio.livekit.sdk.RoomOptions;
importio.livekit.sdk.RoomListener;
importio.livekit.sdk.signaling.LiveKitClient;
publicclassExample {
publicstaticvoidmain(String[] args) {
RoomOptionsoptions = newRoomOptions();
LiveKitClientclient = newLiveKitClient(options);
Roomroom = client.getRoom();
room.addListener(newRoomListener() {
@OverridepublicvoidonConnected(Roomr) {
System.out.println("Connected to room: " + r.getName());
}
@OverridepublicvoidonParticipantConnected(Roomr, RemoteParticipantparticipant) {
System.out.println("Participant joined: " + participant.getIdentity());
}
// ... other callbacks
});
client.connect("wss://your-server.livekit.cloud", "your-access-token");
}
}The examples module includes working examples:
| Example | Description |
|---|---|
BasicRoomExample | Join room and handle events |
PublishExample | Publish audio/video tracks |
SubscribeExample | Subscribe to remote tracks |
DataChannelExample | Interactive data messaging |
Run examples:
export LIVEKIT_URL=wss://your-server.livekit.cloud
export LIVEKIT_TOKEN=your-access-token
./gradlew :examples:run- Getting Started - Installation and basic usage
- Publishing Media - Audio/video publishing guide
- Data Channels - Real-time messaging
- E2EE Guide - End-to-end encryption
- API Reference - Complete API documentation
livekit-java-sdk/
├── protocol/ # Protobuf definitions and generated classes
├── core/ # Room, Participant, Track, E2EE APIs
├── signaling/ # WebSocket signaling client
├── rtc/ # WebRTC integration
├── examples/ # Usage examples
└── docs/ # Documentation
# Build all modules
./gradlew build
# Run tests
./gradlew test# Format code
./gradlew spotlessApply
# Publish to local repository
./gradlew publishToMavenLocalData channel encryption is supported via E2EEManager:
importio.livekit.sdk.e2ee.E2EEManager;
importio.livekit.sdk.e2ee.BaseKeyProvider;
BaseKeyProviderkeyProvider = newBaseKeyProvider();
keyProvider.setSharedKey(secretKeyBytes);
E2EEManagere2ee = newE2EEManager(keyProvider);
byte[] encrypted = e2ee.encryptData(plaintext, participantId);
byte[] decrypted = e2ee.decryptData(encrypted, participantId);Note: Media track E2EE requires FrameCryptor API which is not yet exposed by webrtc-java.
- Screen sharing not yet exposed (webrtc-java supports it)
- Simulcast/SVC layer selection not implemented
- Media track E2EE blocked by webrtc-java library limitation
Apache License 2.0