kohii-core/kohii.v1.core/PlayerPool

PlayerPool

abstract class PlayerPool<PLAYER : Any> @JvmOverloads constructor(@IntRange(from = 1) poolSize: Int = DEFAULT_POOL_SIZE)

Definition of a pool to provide PLAYER instance for the consumer.

Constructors

fun PlayerPool(@IntRange(from = 1) poolSize: Int = DEFAULT_POOL_SIZE)

Types

object Companion

Functions

open fun clear()

Destroy all available PLAYER instances in the pool.

abstract fun createPlayer(media: Media): PLAYER

Create a new PLAYER instance that can be used to play the media object.

abstract fun destroyPlayer(player: PLAYER)

Destroy the PLAYER instance. After this, the player must not be reused.

fun getPlayer(media: Media): PLAYER

Acquire a PLAYER that can be used to play the media from the pool. If there is no available instance in the pool, this method will create a new one.

fun putPlayer(media: Media, player: PLAYER): Boolean

Release an unused PLAYER to the pool. If the pool is already full, this method must destroy the PLAYER instance. Return true if the instance is successfully put back to the pool, or false otherwise.

open fun resetPlayer(player: PLAYER)

Reset the internal state of the player instance before putting it back to the pool.