1. Install LiveKit Components SDK
LiveKit Components for Android Compose is available as a Maven package.
...dependencies {implementation "io.livekit:livekit-android-compose-components:<current version>"}
See our releases page for information on the latest version of the SDK.
You'll also need JitPack as one of your repositories. In your settings.gradle
file:
dependencyResolutionManagement {repositories {google()mavenCentral()//...maven { url 'https://jitpack.io' }}}
2. Permissions
LiveKit relies on the RECORD_AUDIO
and CAMERA
permissions to use the microphone and camera. These permission must be requested at runtime, like so:
/*** Checks if the RECORD_AUDIO and CAMERA permissions are granted.** If not granted, will request them. Will call onPermissionGranted if/when* the permissions are granted.*/fun ComponentActivity.requireNeededPermissions(onPermissionsGranted: (() -> Unit)? = null) {val requestPermissionLauncher =registerForActivityResult(ActivityResultContracts.RequestMultiplePermissions()) { grants ->// Check if any permissions weren't granted.for (grant in grants.entries) {if (!grant.value) {Toast.makeText(this,"Missing permission: ${grant.key}",Toast.LENGTH_SHORT).show()}}// If all granted, notify if needed.if (onPermissionsGranted != null && grants.all { it.value }) {onPermissionsGranted()}}val neededPermissions = listOf(Manifest.permission.RECORD_AUDIO, Manifest.permission.CAMERA).filter { ContextCompat.checkSelfPermission(this, it) == PackageManager.PERMISSION_DENIED }.toTypedArray()if (neededPermissions.isNotEmpty()) {requestPermissionLauncher.launch(neededPermissions)} else {onPermissionsGranted?.invoke()}}
3. Join a room
Note that this example hardcodes a token we generated for you that expires in 2 hours. In a real app, you’ll need your server to generate a token for you.
// !! Note !!// This sample hardcodes a token which expires in 2 hours.const val wsURL = "<your LiveKit server URL>"const val token = "<generate a token>"// In production you should generate tokens on your server, and your client// should request a token from your server.class MainActivity : ComponentActivity() {override fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState)requireNeededPermissions {setContent {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.// Audio tracks are automatically played.LazyColumn(modifier = Modifier.fillMaxSize()) {items(trackRefs.size) { index ->VideoTrackView(trackReference = trackRefs[index],modifier = Modifier.fillParentMaxHeight(0.5f))}}}}}}}
(For more details, you can reference the complete quickstart app.)
4. Next Steps
- Set up a server to generate tokens for your app at runtime by following this guide: Generating Tokens.
- View the full SDK reference and GitHub repository for more documentation and examples.
Happy coding!