kiteplayer/io.github.yuroyami.kiteplayer.session/BackgroundPolicy

BackgroundPolicy

enum BackgroundPolicy : Enum<BackgroundPolicy>

What playback should do when the application leaves the screen.

A picture in picture window that the background handler was given counts as the screen while it shows, because the viewer is still watching the picture there.

Entries

ContinueAudio

Keep the sound, park video decoding while away, and resume it on return.

PauseAll

Pause on leaving, and play again on return only when this policy was the one that paused.

Ignore

Do nothing.

Properties

entries

val entries: EnumEntries<BackgroundPolicy>

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): BackgroundPolicy

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<BackgroundPolicy>

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