mediaplayer/io.github.kdroidfilter.composemediaplayer

Package-level declarations

Types

data class AudioMode(val interruptionMode: InterruptionMode = InterruptionMode.DoNotMix, val playsInSilentMode: Boolean = true)

Configures how the media player interacts with the system audio session.

CacheConfig

data class CacheConfig(val enabled: Boolean = false, val maxCacheSizeBytes: Long = 100L * 1024L * 1024L)

Configuration for video caching. When enabled, downloaded video data is stored on disk so that subsequent plays of the same URI load from the local cache instead of re-downloading.

DefaultVideoPlayerState

@UnstableApi

@Stable

open class DefaultVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig()) : VideoPlayerState

@Stable

open class DefaultVideoPlayerState : VideoPlayerState

Represents the state and behavior of a video player. This class provides properties and methods to control video playback, manage the playback state, and interact with platform-specific implementations.

@Stable

open class DefaultVideoPlayerState : VideoPlayerState

Implementation of VideoPlayerState for WebAssembly/JavaScript platform. Manages the state of a video player including playback controls, media information, and error handling.

FullscreenManager

object FullscreenManager

Manages fullscreen functionality for the video player

InitialPlayerState

enum InitialPlayerState : Enum<InitialPlayerState>

Represents the initial state of the player after opening a media file or URI.

InterruptionMode

enum InterruptionMode : Enum<InterruptionMode>

Controls how the media player interacts with other apps' audio.

PreviewableVideoPlayerState

data class PreviewableVideoPlayerState(val hasMedia: Boolean = true, val isPlaying: Boolean = true, val isLoading: Boolean = false, var volume: Float = 1.0f, var sliderPos: Float = 500.0f, var userDragging: Boolean = false, var loop: Boolean = true, var playbackSpeed: Float = 1.0f, val positionText: String = "00:05", val durationText: String = "00:10", val currentTime: Double = 5000.0, val duration: Double = 10.0, var isFullscreen: Boolean = false, val aspectRatio: Float = 1.7f, val error: VideoPlayerError? = null, val metadata: VideoMetadata = VideoMetadata(), var subtitlesEnabled: Boolean = false, var currentSubtitleTrack: SubtitleTrack? = null, val availableSubtitleTracks: MutableList<SubtitleTrack> = emptyList<SubtitleTrack>().toMutableList(), var subtitleTextStyle: TextStyle = TextStyle.Default, var subtitleBackgroundColor: Color = Color.Transparent, val isPipSupported: Boolean = false, var isPipActive: Boolean = false, var isPipEnabled: Boolean = false, var onPlaybackEnded: () -> Unit? = null, var onRestart: () -> Unit? = null) : VideoPlayerState

Helper to mock the VideoPlayerState.

SubtitleTrack

@Stable

data class SubtitleTrack(val label: String, val language: String, val src: String)

SurfaceType

enum SurfaceType : Enum<SurfaceType>

VideoMetadata

@Stable

class VideoMetadata(title: String? = null, duration: Long? = null, width: Int? = null, height: Int? = null, bitrate: Long? = null, frameRate: Float? = null, mimeType: String? = null, audioChannels: Int? = null, audioSampleRate: Int? = null)

Represents metadata information of a video file.

VideoPlayerError

sealed class VideoPlayerError

Represents different types of errors that can occur during video playback in a video player.

VideoPlayerState

@Stable

interface VideoPlayerState

Represents the state and controls for a video player. This class provides properties and methods to manage video playback, including play, pause, stop, seeking, and more. It maintains information about the playback state, such as whether the video is currently playing, volume levels, and playback position.

Functions

AutoPipEffect

@Composable

fun AutoPipEffect(playerState: VideoPlayerState)

createVideoPlayerState

actual fun createVideoPlayerState(audioMode: AudioMode, cacheConfig: CacheConfig): VideoPlayerState