media/com.splendo.kaluga.media

Package-level declarations

Types

class ActivityMediaSurfaceProvider<Activity : Activity>(activityClass: KClass<Activity>, activitySurfaceHolder: Activity.() -> SurfaceHolder?, observer: LifecycleManagerObserver = LifecycleManagerObserver()) : MediaSurfaceProvider, ActivityLifecycleSubscribable

A MediaSurfaceProvider that provides a SurfaceHolder from a given Activity

AndroidMediaPlayer

typealias AndroidMediaPlayer = MediaPlayer

AndroidTrackInfo

typealias AndroidTrackInfo = MediaPlayer.TrackInfo

AVPlayerLayerMediaSurfaceProvider

class AVPlayerLayerMediaSurfaceProvider(initialLayer: AVPlayerLayer?) : BaseMediaSurfaceProvider<AVPlayerLayer>

A BaseMediaSurfaceProvider that takes an AVPlayerLayer directly.

AVPlayerViewControllerMediaSurfaceProvider

class AVPlayerViewControllerMediaSurfaceProvider(initialViewController: AVPlayerViewController?) : BaseMediaSurfaceProvider<AVPlayerViewController>

A BaseMediaSurfaceProvider that takes an AVPlayerViewController directly.

AVPlayerViewMediaSurfaceProvider

class AVPlayerViewMediaSurfaceProvider(initialView: AVPlayerView?) : BaseMediaSurfaceProvider<AVPlayerView>

A BaseMediaSurfaceProvider that takes an AVPlayerView directly.

BaseMediaManager

abstract class BaseMediaManager(mediaSurfaceProvider: MediaSurfaceProvider?, coroutineContext: CoroutineContext) : MediaManager, CoroutineScope

An abstract implementation for MediaManager

BaseMediaSurfaceProvider

abstract class BaseMediaSurfaceProvider<Value>(initialValue: Value?) : MediaSurfaceProvider

A MediaSurfaceProvider that grabs a MediaSurface from a given Value. Shared across iOS + macOS — UIKit/NSView-specific subclasses live in iosMain/macosMain.

BasePlaybackStateRepo

abstract class BasePlaybackStateRepo(createInitialState: HotStateFlowRepo<PlaybackState>.() -> PlaybackState, coroutineContext: CoroutineContext) : HotStateFlowRepo<PlaybackState>

An abstract ColdStateFlowRepo for managing PlaybackState

BindingMediaSurfaceProvider

class BindingMediaSurfaceProvider(initialBinding: MediaSurfaceBinding?) : BaseMediaSurfaceProvider<MediaSurfaceBinding>

A BaseMediaSurfaceProvider that takes a raw MediaSurfaceBinding.

DefaultMediaManager

actual class DefaultMediaManager : BaseMediaManager

Default implementation of BaseMediaManager

expect class DefaultMediaManager : BaseMediaManager

Default implementation of BaseMediaManager

actual class DefaultMediaManager : BaseMediaManager

Default implementation of BaseMediaManager

actual class DefaultMediaManager : BaseMediaManager

Default implementation of BaseMediaManager

actual class DefaultMediaManager : BaseMediaManager

Default implementation of BaseMediaManager for the JS family, backed by an HTMLMediaElement.

DefaultMediaPlayer

class DefaultMediaPlayer(createPlaybackStateRepo: (CoroutineContext) -> BasePlaybackStateRepo, coroutineContext: CoroutineContext) : MediaPlayer, CoroutineScope

A default implementation of MediaPlayer

DefaultPlayableMedia

actual class DefaultPlayableMedia : PlayableMedia

Default implementation of PlayableMedia

expect class DefaultPlayableMedia : PlayableMedia

Default implementation of PlayableMedia

actual class DefaultPlayableMedia : PlayableMedia

Default implementation of PlayableMedia

actual class DefaultPlayableMedia : PlayableMedia

Default implementation of PlayableMedia

actual class DefaultPlayableMedia : PlayableMedia

Default implementation of PlayableMedia for the JS family, reading live from the player's HTMLMediaElement (held in the registry under id).

DefaultSoundPlayer

actual class DefaultSoundPlayer : SoundPlayer

A default implementation of SoundPlayer

expect class DefaultSoundPlayer : SoundPlayer

A default implementation of SoundPlayer

actual class DefaultSoundPlayer : SoundPlayer

A default implementation of SoundPlayer

actual class DefaultSoundPlayer : SoundPlayer

A default implementation of SoundPlayer

actual class DefaultSoundPlayer : SoundPlayer

A default implementation of SoundPlayer for the JS family, backed by an HTMLAudioElement.

LocalFileMediaSource

data class LocalFileMediaSource(val url: String) : MediaSource.Local

A MediaSource.Local referencing a bundled/relative file by its URL.

MediaManager

interface MediaManager : VolumeController, MediaSurfaceController

Manages media playback

MediaPlayer

interface MediaPlayer : VolumeController, MediaSurfaceController

Plays a MediaSource

MediaSoundError

sealed class MediaSoundError : Error

A SoundPlayer specific error

MediaSource

actual sealed class MediaSource

The source at which PlayableMedia can be found

actual sealed class MediaSource

The source at which PlayableMedia can be found

expect sealed class MediaSource

The source at which PlayableMedia can be found

actual sealed class MediaSource

The source at which PlayableMedia can be found. On the web a media source is always a URL loaded by an HTMLMediaElement.

MediaSurface

actual data class MediaSurface

A surface on which the video component of a PlayableMedia can be rendered. Exposes a SurfaceHolder to bind to

actual data class MediaSurface

A surface on which the video component of a PlayableMedia can be rendered. Shared across iOS + macOS — the iOS-only AVPlayerViewController and macOS-only AVPlayerView factory constructors live in iosMain/macosMain respectively, alongside the platform-specific MediaSurfaceProvider implementations.

expect class MediaSurface

A surface on which the video component of a PlayableMedia can be rendered

actual class MediaSurface

A surface on which the video component of a PlayableMedia can be rendered. On the web this is the id of the DOM element the player's <video> element should be appended to.

MediaSurfaceBinding

typealias MediaSurfaceBinding = (AVPlayer?) -> Unit

MediaSurfaceController

interface MediaSurfaceController

Controller for rendering a PlayableMedia to a MediaSurface

MediaSurfaceProvider

interface MediaSurfaceProvider : LifecycleSubscribable

A LifecycleSubscribable that provides a MediaSurface

NSViewMediaSurfaceProvider

class NSViewMediaSurfaceProvider(initialView: NSView?) : BaseMediaSurfaceProvider<NSView>

A BaseMediaSurfaceProvider that attempts to grab the MediaSurface from an NSView. Requires the view's backing layer to be an AVPlayerLayer (i.e. wantsLayer = true and a Core-Animation layer-hosted view).

PlayableMedia

interface PlayableMedia

A media that can be played by a MediaPlayer

PlaybackError

sealed class PlaybackError : Exception

An Exception that may occur during playback

PlaybackState

sealed interface PlaybackState : KalugaState

A KalugaState of playback

PlaybackStateFlowRepo

typealias PlaybackStateFlowRepo = StateRepo<PlaybackState, MutableStateFlow<PlaybackState>>

A StateRepo/MutableStateFlow of PlaybackState

PlaybackStateRepo

open class PlaybackStateRepo(mediaManager: MediaManager, coroutineContext: CoroutineContext) : BasePlaybackStateRepo

A BasePlaybackStateRepo managed using a MediaManager

Resolution

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

The screen resolution of a video

SoundPlayer

interface SoundPlayer : AutoCloseable

Plays a sound from MediaSource Meant for short low latency audio

TrackInfo

data class TrackInfo(val id: Int, val type: TrackInfo.Type, val language: String)

Info of the track of a PlayableMedia

UIViewMediaSurfaceProvider

class UIViewMediaSurfaceProvider(initialView: UIView?) : BaseMediaSurfaceProvider<UIView>

A BaseMediaSurfaceProvider that attempts to grab the MediaSurface from a UIView. Requires UIView.layer to be an AVPlayerLayer.

URLMediaSource

data class URLMediaSource(val url: String) : MediaSource

A MediaSource referenced by an (absolute or relative) URL.

VolumeController

interface VolumeController

Controller for adjusting the volume

Properties

duration

val MediaPlayer.duration: Flow<Duration>

A Flow that provides the Duration of the current PlayableMedia of a MediaPlayer. If no PlayableMedia is loaded this will result in Duration.ZERO.

isVideo

val PlayableMedia.isVideo: Boolean

If true this PlayableMedia has a video component

Functions

ActivityMediaSurfaceProvider

inline fun <Activity : Activity> ActivityMediaSurfaceProvider(noinline activitySurfaceHolder: Activity.() -> SurfaceHolder?): ActivityMediaSurfaceProvider<Activity>

Creates an ActivityMediaSurfaceProvider

mediaSourceFromLocalFile

actual fun mediaSourceFromLocalFile(fileName: String, fileType: String): MediaSource.Local

Attempts to create a MediaSource from a file name

actual fun mediaSourceFromLocalFile(fileName: String, fileType: String): MediaSource.Local

Attempts to create a MediaSource from a file name

expect fun mediaSourceFromLocalFile(fileName: String, fileType: String): MediaSource.Local

Attempts to create a MediaSource from a file name

actual fun mediaSourceFromLocalFile(fileName: String, fileType: String): MediaSource.Local

Attempts to create a MediaSource from a file name

mediaSourceFromUrl

actual fun mediaSourceFromUrl(url: String): MediaSource?

Attempts to create a MediaSource from a url string

actual fun mediaSourceFromUrl(url: String): MediaSource?

Attempts to create a MediaSource from a url string

expect fun mediaSourceFromUrl(url: String): MediaSource?

Attempts to create a MediaSource from a url string

actual fun mediaSourceFromUrl(url: String): MediaSource?

Attempts to create a MediaSource from a url string

MediaSurface

fun MediaSurface(playerView: AVPlayerView): MediaSurface

macOS-only convenience constructor binding an AVPlayer to an AVPlayerView.

fun MediaSurface(viewController: AVPlayerViewController): MediaSurface

Convenience constructor binding an AVPlayer to an AVPlayerViewController.

play

suspend fun MediaPlayer.play(playbackParameters: PlaybackState.PlaybackParameters = PlaybackState.PlaybackParameters(), restartIfStarted: Boolean = false)

Forces the MediaPlayer to start playback and suspends until playback has completed

playTime

fun MediaPlayer.playTime(pollingInterval: Duration): Flow<Duration>

A Flow that polls the playtime of the current PlayableMedia of a MediaPlayer as a Duration. If no PlayableMedia is loaded this will result in Duration.ZERO.