kiteplayer-core/io.github.yuroyami.kiteplayer/PlayerMemento

PlayerMemento

data class PlayerMemento(val queue: List<MediaItem>, val queueIndex: Int, val position: Duration, val speed: Double, val preservePitch: Boolean, val volume: Float, val muted: Boolean, val loop: LoopMode, val shuffle: Boolean, val subtitleDelay: Duration, val audioDelay: Duration, val audioLanguage: String?, val subtitleLanguage: String?, val subtitlesOff: Boolean, val secondarySubtitleLanguage: String? = null, val balance: Float = 0.0f, val equalizer: EqualizerSettings = EqualizerSettings.Flat, val subtitleScale: Float = 1.0f, val subtitlePosition: Float = 1.0f, val forcedPicturesOnly: Boolean = false, val subtitleStyle: SubtitleStyleOverride? = null, val videoScale: VideoScale = VideoScale.Fit, val videoTransform: VideoTransform = VideoTransform.Identity, val videoAdjustments: VideoAdjustments = VideoAdjustments.Identity, val renderQuality: RenderQuality = RenderQuality.Off, val videoEnabled: Boolean = true, val queueOrder: List<Int> = emptyList(), val hdrPolicy: HdrPolicy = HdrPolicy.Auto, val stereoMode: StereoMode = StereoMode.Stereo, val nightMode: Boolean = false, val dialogueLevelDb: Float = 0.0f, val pitchSemitones: Double = 0.0, val skipSilence: Boolean = false)

Everything needed to come back to where playback was: the queue, the item, the position and every setting. Taken with KitePlayer.memento, handed back to KitePlayer.restore. A value the application stores however it likes; no serialisation is imposed. asProperties is a flat string form for applications that keep key-value text, and fromProperties reads it back.

What the text form cannot carry: MediaItem.io factories, which nobody can store, MediaItem.externalSubtitles, MediaItem.thumbnails, MediaItem.videoFilter and MediaItem.audioFilter. asProperties drops all five, and an item that needs one is rebuilt by the application before KitePlayer.restore. Headers, raw open options, the format hint, the demux settings, the start position, the clip, and the title, artist and album are strings and travel.

Tracks are remembered by LANGUAGE rather than by id, because ids belong to one open of one container and a memento outlives both.

Constructors

PlayerMemento

constructor(queue: List<MediaItem>, queueIndex: Int, position: Duration, speed: Double, preservePitch: Boolean, volume: Float, muted: Boolean, loop: LoopMode, shuffle: Boolean, subtitleDelay: Duration, audioDelay: Duration, audioLanguage: String?, subtitleLanguage: String?, subtitlesOff: Boolean, secondarySubtitleLanguage: String? = null, balance: Float = 0.0f, equalizer: EqualizerSettings = EqualizerSettings.Flat, subtitleScale: Float = 1.0f, subtitlePosition: Float = 1.0f, forcedPicturesOnly: Boolean = false, subtitleStyle: SubtitleStyleOverride? = null, videoScale: VideoScale = VideoScale.Fit, videoTransform: VideoTransform = VideoTransform.Identity, videoAdjustments: VideoAdjustments = VideoAdjustments.Identity, renderQuality: RenderQuality = RenderQuality.Off, videoEnabled: Boolean = true, queueOrder: List<Int> = emptyList(), hdrPolicy: HdrPolicy = HdrPolicy.Auto, stereoMode: StereoMode = StereoMode.Stereo, nightMode: Boolean = false, dialogueLevelDb: Float = 0.0f, pitchSemitones: Double = 0.0, skipSilence: Boolean = false)

Types

Companion

object Companion

Properties

audioDelay

val audioDelay: Duration

audioLanguage

val audioLanguage: String?

The language of the audio track that was playing, or null when unknown or none.

balance

val balance: Float

Stereo balance. An accessibility setting, so it travels.

dialogueLevelDb

val dialogueLevelDb: Float

How far the dialogue was raised or lowered in a downmix, in decibels (#442). It travels.

equalizer

val equalizer: EqualizerSettings

forcedPicturesOnly

val forcedPicturesOnly: Boolean

Whether only the forced pictures of an image subtitle track drew (#513).

hdrPolicy

val hdrPolicy: HdrPolicy

loop

val loop: LoopMode

muted

val muted: Boolean

nightMode

val nightMode: Boolean

Whether the night mode was on (#442). A listening setting, so it travels.

pitchSemitones

val pitchSemitones: Double

How far the pitch was moved, in semitones (#465). It travels with the speed.

position

val position: Duration

preservePitch

val preservePitch: Boolean

queue

val queue: List<MediaItem>

queueIndex

val queueIndex: Int

queueOrder

val queueOrder: List<Int>

The shuffled play order, as positions into queue, when shuffle was on. Empty when shuffle was off. KitePlayer.restore continues this order rather than drawing a new one, so the items already heard do not come round again.

renderQuality

val renderQuality: RenderQuality

secondarySubtitleLanguage

val secondarySubtitleLanguage: String?

The language of the second subtitle track that was showing, or null when none was.

shuffle

val shuffle: Boolean

skipSilence

val skipSilence: Boolean

Whether the silent stretches were shortened (#429). A listening setting, so it travels.

speed

val speed: Double

stereoMode

val stereoMode: StereoMode

What the two front speakers played. An accessibility setting, so it travels (#462).

subtitleDelay

val subtitleDelay: Duration

subtitleLanguage

val subtitleLanguage: String?

The language of the subtitle track that was showing, or null when unknown or none.

subtitlePosition

val subtitlePosition: Float

subtitleScale

val subtitleScale: Float

Subtitle size, place and styling. Accessibility settings, so they travel.

subtitlesOff

val subtitlesOff: Boolean

True when the media had subtitle tracks and none was selected: the viewer turned them off.

subtitleStyle

val subtitleStyle: SubtitleStyleOverride?

videoAdjustments

val videoAdjustments: VideoAdjustments

videoEnabled

val videoEnabled: Boolean

False when the viewer was playing sound only.

videoScale

val videoScale: VideoScale

videoTransform

val videoTransform: VideoTransform

volume

val volume: Float

Functions

asProperties

fun asProperties(): Map<String, String>

Flat string pairs, version-stamped. Keys: version, queue.size, then per item queue.N.uri, queue.N.formatHint, queue.N.startPosition (microseconds), queue.N.clipStart and queue.N.clipEnd (microseconds) for a clipped item, queue.N.title, queue.N.artist, queue.N.album, queue.N.audioContent when it is not automatic, queue.N.header.<name>, queue.N.option.<key> and queue.N.demux.<field>; then queueOrder as space-separated positions when there is one, one key per setting, durations in microseconds, and audioLanguage and subtitleLanguage only when known.