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

KeyframeChoice

enum KeyframeChoice : Enum<KeyframeChoice>

Which keyframe a SeekMode.Keyframe seek lands on, since it does not decode forward to the exact target.

In a file whose keyframes are far apart, such as a screen recording, a long-GOP encode or the recording of a live stream, the choice decides whether a short jump forward goes anywhere: with ten seconds between keyframes, a five second skip forward under Before lands where it started or even earlier. Set it with PlayerConfig.keyframeChoice or live with KitePlayer.setKeyframeChoice. The precise modes are not affected: SeekMode.KeyframeThenRefine always shows the keyframe before the target first, because that is where its decode forward starts.

Entries

Before

The last keyframe at or before the target. Never lands past where you asked; the default.

After

The first keyframe at or after the target, or the last one before it when none follows, so a seek near the end still lands rather than failing.

Closest

Whichever of the keyframes either side of the target is nearer to it, the one before on a tie or when none follows.

InSeekDirection

After for a seek forward from the current position and Before for a seek backward, so a skip button always moves the way it points. mpv applies the same rule to a relative keyframe seek.

Properties

entries

val entries: EnumEntries<KeyframeChoice>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): KeyframeChoice

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<KeyframeChoice>

Returns an array containing the constants of this enum type, in the order they're declared.