LiveKit Components for Android

Table of Contents

Docs

Installation

...
dependencies {
    // The components package has a different versioning than the main LiveKit SDK.
    implementation "io.livekit:livekit-android-compose-components:2.4.2"

    // Snapshots of the latest development version are available at:
    // implementation "io.livekit:livekit-android-compose-components:2.4.3-SNAPSHOT"

    // Depend on LiveKit SDK separately to keep up to date.
    implementation "io.livekit:livekit-android:$livekit_version"
}

subprojects {
    repositories {
        google()
        mavenCentral()
        // ...
        maven { url 'https://jitpack.io' }

        // For SNAPSHOT access
        // maven { url 'https://central.sonatype.com/repository/maven-snapshots/' }
    }
}

Basic Usage

@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