Embed a YouTube video player in a Jetpack Compose app, offering customizable options like autoplay, controls, and fullscreen. Supports commands for loading, playing, pausing, and seeking videos.
YouTube kotlin multiplatform player.
The YouTubePlayer composable allows you to embed a YouTube video player in your Jetpack Compose app.
If you want to thank me or contribute to the development of the backlog, you may donate me. That helps me to concentrate more on the project.
You also might subscribe me on the next platforms to see any updates of my topics
You can add this library to your project using Gradle.
Multiplatform To add to a multiplatform project, add the dependency to the common source-set:
repositories {
mavenCentral()
}
kotlin {
sourceSets {
commonMain {
dependencies {
implementation("io.github.ilyapavlovskii:youtubeplayer-compose:${latest_version}")
}
}
}
}
coroutineScope = rememberCoroutineScope()
hostState = remember { YouTubePlayerHostState() }
( state = hostState.currentState) {
YouTubePlayerState.Error -> {
Text(text = )
}
YouTubePlayerState.Idle -> {
}
YouTubePlayerState.Playing -> {
}
YouTubePlayerState.Ready -> coroutineScope.launch {
hostState.loadVideo(YouTubeVideoId())
}
}
YouTubePlayer(
modifier = Modifier
.fillMaxWidth()
.height(dp)
.gesturesDisabled(),
hostState = hostState,
options = SimpleYouTubePlayerOptionsBuilder.builder {
autoplay()
mute()
controls()
rel()
ivLoadPolicy()
ccLoadPolicy()
fullscreen =
},
)
Composable function has the next major params:
options - to player options builder. All parameters wrapped from official youtube iframe documentation.hostState - controller for track youtube player state and execute one time commandsThe main controller. Contains 2 major public components:
YouTube player state defines actual youtube player state on the screen. Contains the next possible states:
Idle - Idle state means that player is not initialized yetReady - Means that player is ready to playPlaying - player is playing video. Contains the next params:videoId: YouTubeVideoId - id of the video that is playing
duration: Duration - duration of the video
currentTime: Duration - current time of the video
quality: YouTubeEvent.PlaybackQualityChange.Quality - quality of the video, see [YouTubeEvent.PlaybackQualityChange.Quality]
isPlaying: Boolean - is video playing
Error - Defines error state with error message inside.
Copyright 2026 Ilia Pavlovskii
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
suspend fun loadVideo(videoId: YouTubeVideoId) = executeCommand(YouTubeExecCommand.LoadVideo(videoId))
suspend fun play() = executeCommand(YouTubeExecCommand.Play)
suspend fun pause() = executeCommand(YouTubeExecCommand.Pause)
suspend fun seekTo(duration: Duration) = executeCommand(YouTubeExecCommand.SeekTo(duration))
suspend fun seekBy(duration: Duration) = executeCommand(YouTubeExecCommand.SeekBy(duration))
suspend fun mute() = executeCommand(YouTubeExecCommand.Mute)
suspend fun unMute() = executeCommand(YouTubeExecCommand.Unmute)
suspend fun setVolume(volume: Int) = executeCommand(YouTubeExecCommand.SetVolume(volume))
suspend fun setPlaybackRate(rate: Float) = executeCommand(YouTubeExecCommand.SetPlaybackRate(rate))
suspend fun toggleFullScreen() = executeCommand(YouTubeExecCommand.ToggleFullscreen)
LoadVideo(val videoId: YouTubeVideoId,val startSeconds: Duration) - load video by youtube id. Possible to start with default start time offset.
Play - play video
Pause - pause video
SeekTo(val duration: Duration) - seek video to a specified time
SeekBy(val duration: Duration) - seek video by a specified time
Mute - mute sound
Unmute - unmute sound
SetVolume(val volumePercent: Int) - set volume. Expected argument value from 0 to 100.
NextVideo - navigate to a next video
PreviousVideo - navigate to a previous video
SetLoop(val loop: Boolean) - repeat video. Managed by argument.
SetShuffle(val shuffle: Boolean) - shuffle videos. Managed by argument.
Ready - calls when youtube player initialization completePlaybackQualityChange(val quality: Quality) - calls when player quality changesError(val error: String) - error handle event. See argument for details.VideoDuration(val duration: Duration) - calls when video duration initializedStateChanged(val state: State) - calls when video state changed: UNSTARTED,ENDED, PLAYING, PAUSED, BUFFERING, CUED.TimeChanged(val time: Duration) - timestamp changedOnVideoIdHandled(val videoId: YouTubeVideoId) - callback when video loadedSurfaced from shared tags and platforms — no rankings paid for.