kiteplayer-view/io.github.yuroyami.kiteplayer.view

Package-level declarations

Types

AndroidPlayerViewRenderer

interface AndroidPlayerViewRenderer : PlayerViewRenderer

A renderer that can follow the SurfaceView owned by KitePlayerView.

AndroidPlayerViewRendererFactory

fun interface AndroidPlayerViewRendererFactory

Creates the Android renderer adapter used by KitePlayerView.

ApplePlayerViewRendererFactory

fun interface ApplePlayerViewRendererFactory

Creates the renderer hosted by KitePlayerUIView.

AwtPlayerViewRenderer

interface AwtPlayerViewRenderer : PlayerViewRenderer

Renderer adapter for KitePlayerAwtView.

AwtPlayerViewRendererFactory

fun interface AwtPlayerViewRendererFactory

Creates the desktop renderer adapter used by KitePlayerAwtView.

enum FloatingCorner : Enum<FloatingCorner>

The screen corner a floating picture window opens in.

FloatingWindowLabels

data class FloatingWindowLabels(val play: String = "Play", val pause: String = "Pause", val backToApp: String = "Back to app", val close: String = "Close")

The words of the floating window's right-click menu. English by default; pass translated ones.

FloatingWindowOptions

data class FloatingWindowOptions(val widthFraction: Float = 0.25f, val corner: FloatingCorner = FloatingCorner.BottomRight, val margin: Int = 24, val labels: FloatingWindowLabels = FloatingWindowLabels())

Where and how large the floating picture window of KitePlayerPictureInPicture opens.

KitePlayerAwtView

open class KitePlayerAwtView : Canvas

A desktop player view: an ordinary AWT canvas that a renderer paints video into.

KitePlayerPictureInPicture

class KitePlayerPictureInPicture : AutoCloseable

Puts a KitePlayer in the small floating window, and lets that window drive it, on iOS and macOS.

class KitePlayerPictureInPicture : AutoCloseable

Shows the picture of a KitePlayerAwtView in a small window that stays above every other window.

class KitePlayerPictureInPicture : AutoCloseable

Puts the canvas a web player draws into in a small window above the viewer's other windows.

KitePlayerUIView

class KitePlayerUIView : UIView

The reusable iOS player view: a black UIView whose video layer's whole lifecycle is handled here.

open class KitePlayerView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout

A reusable Android player view for layouts, programmatic UI, and Compose AndroidView interop.

PlayerViewDefaults

object PlayerViewDefaults

What a KitePlayerView uses when it has no KitePlayerView.rendererFactory of its own.

object PlayerViewDefaults

What a KitePlayerUIView uses when it has no KitePlayerUIView.rendererFactory of its own.

object PlayerViewDefaults

What a KitePlayerAwtView uses when it has no KitePlayerAwtView.rendererFactory of its own.

PlayerViewRenderer

interface PlayerViewRenderer : VideoRenderer

Renderer contract used by a platform player view.

WebPictureInPictureMode

enum WebPictureInPictureMode : Enum<WebPictureInPictureMode>

The browser feature a web KitePlayerPictureInPicture opens its window with.

Properties

DEFAULT_VIDEO_ACCESSIBILITY_LABEL

const val DEFAULT_VIDEO_ACCESSIBILITY_LABEL: String

What a screen reader calls the video surface when nothing more specific is set.

Functions

accessibilityStateText

fun accessibilityStateText(status: PlaybackStatus, position: Duration, duration: Duration?): String

What a screen reader should say about the player's state, as one sentence.

enterPictureInPicture

fun KitePlayerView.enterPictureInPicture(activity: Activity): Boolean

Enters picture in picture with this view's own parameters.

keepPictureInPictureParamsCurrent

fun KitePlayerView.keepPictureInPictureParamsCurrent(activity: Activity, autoEnterWhilePlaying: Boolean = true): AutoCloseable

Keeps activity's picture-in-picture parameters matching what this view is showing.