https://github.com/livekit/components-android
Jetpack Compose Components for LiveKit Android SDK
https://github.com/livekit/components-android
Last synced: 11 months ago
JSON representation
Jetpack Compose Components for LiveKit Android SDK
- Host: GitHub
- URL: https://github.com/livekit/components-android
- Owner: livekit
- License: apache-2.0
- Created: 2023-06-16T12:17:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-22T02:22:58.000Z (11 months ago)
- Last Synced: 2025-07-22T04:25:48.565Z (11 months ago)
- Language: Kotlin
- Homepage: https://docs.livekit.io/
- Size: 1.51 MB
- Stars: 19
- Watchers: 16
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# LiveKit Components for Android
Use this SDK to add realtime video, audio and data features to your Android 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.
# Table of Contents
- [Docs](#docs)
- [Installation](#installation)
- [Usage](#basic-usage)
## Docs
Docs and guides at [https://docs.livekit.io](https://docs.livekit.io)
## Installation
LiveKit Components for Android is available as a Maven package.
```groovy title="build.gradle"
...
dependencies {
// The components package has a different versioning than the main LiveKit SDK.
implementation "io.livekit:livekit-android-compose-components:1.4.0"
// Snapshots of the latest development version are available at:
// implementation "io.livekit:livekit-android-compose-components:1.4.1-SNAPSHOT"
// Depend on LiveKit SDK separately to keep up to date.
implementation "io.livekit:livekit-android:$livekit_version"
}
```
You'll also need jitpack as one of your repositories.
```groovy
subprojects {
repositories {
google()
mavenCentral()
// ...
maven { url 'https://jitpack.io' }
// For SNAPSHOT access
// maven { url 'https://central.sonatype.com/repository/maven-snapshots/' }
}
}
```
## Basic Usage
```kotlin
@Composable
fun exampleComposable() {
// Create and connect to a room.
RoomScope(
url = wsURL,
token = token,
audio = true,
video = true,
connect = true,
) {
// Get all the tracks in the room
val trackRefs = rememberTracks()
// Display the video tracks
LazyColumn(modifier = Modifier.fillMaxSize()) {
items(trackRefs.size) { index ->
VideoTrackView(
trackReference = trackRefs[index],
modifier = Modifier.fillParentMaxHeight(0.5f)
)
}
}
}
}
```
## Example App
See our [Meet Example app](https://github.com/livekit-examples/android-components-meet) for a simple teleconferencing app, and [Livestream Example app](https://github.com/livekit-examples/android-livestream) for a
fully-functional livestreaming app, with more fleshed out usage of the Components SDK.
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