mediaplayer/io.github.kdroidfilter.composemediaplayer.windows/WindowsVideoPlayerState

WindowsVideoPlayerState

class WindowsVideoPlayerState : VideoPlayerState

Windows implementation of the video player state. Handles media playback using Media Foundation on Windows platform.

Constructors

WindowsVideoPlayerState

constructor()

Types

object Companion

Properties

open override val aspectRatio: Float

availableSubtitleTracks

open override val availableSubtitleTracks: MutableList<SubtitleTrack>

currentSubtitleTrack

open override var currentSubtitleTrack: SubtitleTrack?

open override val currentTime: Double

open override val duration: Double

Returns the total duration of the media in seconds.

open override val durationText: String

Returns the total duration of the video as a formatted string.

open override val error: VideoPlayerError?

open override val hasMedia: Boolean

open override var isFullscreen: Boolean

open override var isLoading: Boolean

open var isPipActive: Boolean

open var isPipEnabled: Boolean

open val isPipSupported: Boolean

open override val isPlaying: Boolean

Indicates whether the video is currently playing.

open override var loop: Boolean

Specifies if the video should loop when it reaches the end.

open override val metadata: VideoMetadata

onPlaybackEnded

open override var onPlaybackEnded: () -> Unit?

Callback invoked when playback reaches the end of the media. Only called when loop is false. May be invoked from a background thread.

open override var onRestart: () -> Unit?

Callback invoked when playback restarts from the beginning due to looping. Only called when loop is true. May be invoked from a background thread.

open override var playbackSpeed: Float

open override val positionText: String

Returns the current playback position as a formatted string.

open override var sliderPos: Float

Represents the current playback position as a value between 0.0 and 1000.0.

subtitleBackgroundColor

open override var subtitleBackgroundColor: Color

subtitlesEnabled

open override var subtitlesEnabled: Boolean

subtitleTextStyle

open override var subtitleTextStyle: TextStyle

open override var userDragging: Boolean

Denotes whether the user is manually adjusting the playback position.

var videoHeight: Int

var videoWidth: Int

open override var volume: Float

Volume control for the player (0.0 to 1.0) Any modification triggers the native call SetAudioVolume

Functions

open fun clearCache()

Clears the shared video cache, removing all cached media data from disk.

open override fun clearError()

disableSubtitles

open override fun disableSubtitles()

open override fun dispose()

Releases all resources used by the video player (native players, coroutines, observers, etc.).

open suspend fun enterPip(): PipResult

fun onResized(width: Int = 0, height: Int = 0)

Called when the player surface is resized Temporarily pauses frame processing to avoid artifacts during resize For 4K videos, we need a longer delay to prevent memory pressure

open fun openAsset(fileName: String, initializeplayerState: InitialPlayerState = InitialPlayerState.PLAY)

Opens a media file bundled with the application.

open override fun openFile(file: PlatformFile, initializeplayerState: InitialPlayerState = InitialPlayerState.PLAY)

open override fun openUri(uri: String, initializeplayerState: InitialPlayerState = InitialPlayerState.PLAY)

Opens a media file or URL for playback

open override fun pause()

Pauses playback if currently playing

open override fun play()

Starts or resumes playback. If media is not loaded yet (openUri in progress), waits for it to finish instead of triggering a second open which would race with the first.

open fun restart()

Restarts playback from the beginning. Works reliably from any state, including when playback has ended.

open fun seekFinished()

Commits the seek after a user-driven seek interaction. Performs the actual seek on the player and ends the dragging state.

open fun seekStart(value: Float)

Begins a user-driven seek interaction (e.g. slider drag). Updates the visual slider position without performing the actual seek on the player. Must be followed by seekFinished to commit the seek.

open override fun seekTo(value: Float)

Seeks to a specific playback position. The value should be between 0.0 and 1000.0.

selectSubtitleTrack

open override fun selectSubtitleTrack(track: SubtitleTrack?)

open override fun stop()

Stops playback and releases media resources This will close the media file but keep the player instance

toggleFullscreen

open override fun toggleFullscreen()

Toggles the fullscreen state of the video player