Package-level declarations

AndroidMediaSourceRequest

fun interface AndroidMediaSourceProvider

data class AndroidMediaSourceRequest(val mediaItem: MediaItem, val requestHeaders: Map<String, String>)

AudioMode

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

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

DefaultVideoPlayerState

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

open class DefaultVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: ERROR CLASS: Symbol not found for CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()) : <ERROR CLASS> ERROR CLASS: Symbol not found for VideoPlayerState

open class DefaultVideoPlayerState(playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()) : 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.

Hdr10PlusDistributionPercentile

open class DefaultVideoPlayerState(playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()) : VideoPlayerState

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

DesktopVideoBackend

enum DesktopVideoBackend : Enum<DesktopVideoBackend>

Selects the JVM desktop playback backend.

ExternalMediaToolStatus

data class ExternalMediaToolStatus(val available: Boolean, val path: String? = null, val detail: String? = null)

Status for an optional media tool used by JVM fallbacks.

FullscreenManager

object FullscreenManager

Manages fullscreen functionality for the video player

data class Hdr10PlusDistributionPercentile(val percentage: Int, val percentileMaxRgb: Int)

Hdr10PlusMetadata

Hdr10PlusMetadataTimeline

data class Hdr10PlusMetadata(val timestampUs: Long, val applicationIdentifier: Int, val applicationVersion: Int, val targetedSystemDisplayMaximumLuminance: Int, val targetedSystemDisplayActualPeakLuminance: Hdr10PlusPeakLuminanceGrid?, val masteringDisplayActualPeakLuminance: Hdr10PlusPeakLuminanceGrid?, val windows: List<Hdr10PlusWindowMetadata>)

One SMPTE ST 2094-40 metadata unit associated with a decoded frame timestamp.

Hdr10PlusMetadataParser

object Hdr10PlusMetadataParser

Parser for HDR10+ User Data Registered ITU-T T.35 payloads carrying SMPTE ST 2094-40.

class Hdr10PlusMetadataTimeline(capacity: Int = DEFAULT_TIMELINE_CAPACITY)

Bounded timestamp index used by streaming bridges to attach dynamic metadata to decoded frames.

Hdr10PlusParseResult

sealed interface Hdr10PlusParseResult

Hdr10PlusPeakLuminanceGrid

data class Hdr10PlusPeakLuminanceGrid(val rows: Int, val columns: Int, val values: List<Int>)

Hdr10PlusToneMapping

data class Hdr10PlusToneMapping(val kneePointX: Int, val kneePointY: Int, val bezierCurveAnchors: List<Int>)

Hdr10PlusWindowGeometry

data class Hdr10PlusWindowGeometry(val upperLeftX: Int, val upperLeftY: Int, val lowerRightX: Int, val lowerRightY: Int, val ellipseCenterX: Int, val ellipseCenterY: Int, val rotationAngle: Int, val internalEllipseSemiMajorAxis: Int, val externalEllipseSemiMajorAxis: Int, val externalEllipseSemiMinorAxis: Int, val overlapProcessOption: Int)

Hdr10PlusWindowMetadata

data class Hdr10PlusWindowMetadata(val geometry: Hdr10PlusWindowGeometry? = null, val maxScl: List<Int>, val averageMaxRgb: Int, val distributionPercentiles: List<Hdr10PlusDistributionPercentile>, val fractionBrightPixels: Int, val toneMapping: Hdr10PlusToneMapping? = null, val colorSaturationWeight: Int? = null)

HdrColorMath

object HdrColorMath

Reference color implementation used by platform renderers and CPU/GPU conformance tests.

ICtCpColor

data class ICtCpColor(val intensity: Double, val tritan: Double, val protan: Double)

InterruptionMode

enum InterruptionMode : Enum<InterruptionMode>

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

IosAudioSessionPolicy

object IosAudioSessionPolicy

Process-wide policy for AVAudioSession ownership.

JvmMediaToolAvailability

data class JvmMediaToolAvailability(val vlc: ExternalMediaToolStatus, val libVlc: ExternalMediaToolStatus, val kMediaBridge: ExternalMediaToolStatus, val kMediaBridgeProbe: ExternalMediaToolStatus, val kMediaBridgeSubtitleBurnIn: ExternalMediaToolStatus, val kMediaBridgeHdrToSdrToneMapping: ExternalMediaToolStatus, val libass: ExternalMediaToolStatus)

Snapshot of optional JVM media helper availability.

JvmMediaTools

object JvmMediaTools

LinearRgb

MacOsMediaToolAvailability

data class LinearRgb(val red: Double, val green: Double, val blue: Double)

data class ~~MacOsMediaToolAvailability~~(val vlc: ExternalMediaToolStatus, val libVlc: ExternalMediaToolStatus, val ffmpeg: ExternalMediaToolStatus, val ffmpegWithSubtitlesFilter: ExternalMediaToolStatus, val ffprobe: ExternalMediaToolStatus, val libass: ExternalMediaToolStatus)

Snapshot of optional media helper availability.

MacOsMediaTools

object ~~MacOsMediaTools~~

MediaCodec

enum MediaCodec : Enum<MediaCodec>

Common audio and video codecs that can be checked against the current platform backend.

MediaCodecSupport

data class MediaCodecSupport(val audioCodecs: Set<MediaCodec>, val videoCodecs: Set<MediaCodec>)

Immutable snapshot of codecs reported as supported by the current platform backend.

MediaCodecType

enum MediaCodecType : Enum<MediaCodecType>

Media track type handled by a MediaCodec.

MediaSupport

object MediaSupport

Queries preflight media support for the current platform backend.

MediaSupportSnapshot

class MediaSupportSnapshot

Immutable preflight snapshot of player capabilities and codec support for the current platform.

RenderableVideoPlayerState

class RenderableVideoPlayerState : VideoPlayerState

A library-issued handle for a default VideoPlayerState accepted by the strict VideoPlayerSurface overload.

SurfaceType

enum SurfaceType : Enum<SurfaceType>

VideoPlaybackOptions

VideoProjectionDetectionConfidence

data class VideoPlaybackOptions(val dynamicRangePolicy: DynamicRangePolicy = DynamicRangePolicy.AUTO, val dolbyVisionPolicy: DolbyVisionPolicy = DolbyVisionPolicy.AUTO, val desktopVideoBackend: DesktopVideoBackend = DesktopVideoBackend.AUTO, val extensions: List<VideoPipelineExtension> = emptyList(), val projection: VideoProjectionSettings = VideoProjectionSettings(), val projectionView: VideoProjectionViewSettings = VideoProjectionViewSettings(), val projectionViewControlMode: VideoProjectionViewControlMode = VideoProjectionViewControlMode.AUTO, val projectionTextureCrop: VideoTextureCrop = VideoTextureCrop(), val projectionDetectionMode: VideoProjectionDetectionMode = VideoProjectionDetectionMode.AUTO, val webPlaybackEngine: WebPlaybackEngine = WebPlaybackEngine.MOVI, val webDrmConfiguration: WebDrmConfiguration? = null)

VideoProjectionDetection

data class VideoProjectionDetection(val projection: VideoProjectionSettings, val tokens: Set<String>, val confidence: VideoProjectionDetectionConfidence)

enum VideoProjectionDetectionConfidence : Enum<VideoProjectionDetectionConfidence>

VideoProjectionDetectionInput

data class VideoProjectionDetectionInput(val title: String, val url: String = "", val labels: List<String> = emptyList(), val metadata: List<String> = emptyList(), val videoSizes: List<VideoProjectionVideoSize> = emptyList())

VideoProjectionDetectionMode

enum VideoProjectionDetectionMode : Enum<VideoProjectionDetectionMode>

Controls whether the player should infer 3D/VR projection metadata from source names and media dimensions.

VideoProjectionPreset

data class VideoProjectionPreset(val id: String, val label: String, val projection: VideoProjectionSettings)

VideoProjectionVideoSize

data class VideoProjectionVideoSize(val width: Int, val height: Int)

WebDrmConfiguration

class WebDrmConfiguration(val licenseUrl: String, licenseRequestHeaders: Map<String, String> = emptyMap())

Runtime-only DRM configuration for the WebAssembly player.

WebMediaDependencyConfig

object WebMediaDependencyConfig

Browser dependency configuration for externally hosted media components.

WebPlaybackEngine

enum WebPlaybackEngine : Enum<WebPlaybackEngine>

Selects the playback engine used by the WebAssembly target.

Properties

videoProjectionPresets

val videoProjectionPresets: List<VideoProjectionPreset>

Functions

AutoPipEffect

createRenderableVideoPlayerState

fun AutoPipEffect(playerState: VideoPlayerState)

fun createRenderableVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()): RenderableVideoPlayerState

Creates a default platform-backed state accepted by the strict surface overload.

createVideoPlayerState

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

Creates the default platform-specific video player state.

expect fun createVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()): VideoPlayerState

Creates the default platform-specific video player state.

actual fun createVideoPlayerState(audioMode: AudioMode, cacheConfig: ERROR CLASS: Symbol not found for CacheConfig, playbackOptions: VideoPlaybackOptions): ERROR CLASS: Symbol not found for VideoPlayerState

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

Creates the default platform-specific video player state.

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

Creates the default platform-specific video player state.

defaultVideoPlayerBackend

fun defaultVideoPlayerBackend(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()): VideoPlayerBackend

Creates an injectable descriptor for the default platform backend.

detectVideoProjection

fun detectVideoProjection(input: VideoProjectionDetectionInput): VideoProjectionDetection

isSupported

suspend fun MediaCodec.isSupported(): Boolean

Returns true when this codec is reported as supported by the current platform backend.

matchingVideoProjectionPreset

fun VideoProjectionSettings.matchingVideoProjectionPreset(): VideoProjectionPreset?

nextVideoProjectionPreset

fun VideoProjectionSettings.nextVideoProjectionPreset(): VideoProjectionPreset

openFullscreenView

fun openFullscreenView(playerState: ERROR CLASS: Symbol not found for VideoPlayerState, renderSurface: (ERROR CLASS: Symbol not found for VideoPlayerState, ERROR CLASS: Symbol not found for Modifier, Boolean) -> Unit)

Opens a fullscreen view for the video player on iOS. This function is called when the user toggles fullscreen mode.

rememberRenderableVideoPlayerState

fun rememberRenderableVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions(), androidMediaSourceProvider: AndroidMediaSourceProvider): RenderableVideoPlayerState

Remembers a default platform-backed state accepted by the strict surface overload.

rememberVideoPlayerState

fun rememberVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions(), androidMediaSourceProvider: AndroidMediaSourceProvider): VideoPlayerState

fun rememberVideoPlayerState(audioMode: AudioMode = AudioMode(), cacheConfig: CacheConfig = CacheConfig(), playbackOptions: VideoPlaybackOptions = VideoPlaybackOptions()): VideoPlayerState

Creates and remembers the default platform player and disposes it with the composition.

VideoPlayerSurface

actual fun VideoPlayerSurface(playerState: VideoPlayerState, modifier: Modifier, contentScale: ContentScale, overlay: () -> Unit)

Renders a video player surface that displays and controls video playback.

fun VideoPlayerSurface(playerState: RenderableVideoPlayerState, modifier: Modifier = Modifier, contentScale: ContentScale = ContentScale.Fit, surfaceType: SurfaceType = SurfaceType.Auto, overlay: @Composable () -> Unit = {})

fun VideoPlayerSurface(playerState: VideoPlayerState, modifier: Modifier = Modifier, contentScale: ContentScale = ContentScale.Fit, surfaceType: SurfaceType = SurfaceType.Auto, overlay: @Composable () -> Unit = {})

fun VideoPlayerSurface(playerState: RenderableVideoPlayerState, modifier: Modifier = Modifier, contentScale: ContentScale = ContentScale.Fit, overlay: @Composable () -> Unit = {})

Type-safe overload for library-created player states. The legacy VideoPlayerState overload remains available for source and binary compatibility with the 1.x API.

expect fun VideoPlayerSurface(playerState: VideoPlayerState, modifier: Modifier = Modifier, contentScale: ContentScale = ContentScale.Fit, overlay: @Composable () -> Unit = {})

Renders a video player surface that displays and controls video playback.

actual fun VideoPlayerSurface(playerState: ERROR CLASS: Symbol not found for VideoPlayerState, modifier: ERROR CLASS: Symbol not found for Modifier, contentScale: ERROR CLASS: Symbol not found for ContentScale, overlay: () -> Unit)

actual fun VideoPlayerSurface(playerState: VideoPlayerState, modifier: Modifier, contentScale: ContentScale, overlay: () -> Unit)

Composable function for rendering a video player surface.