player-ui-web/com.bitmovin.player.api.ui/PictureInPictureHandler

PictureInPictureHandler

Represents the base functions required by PlayerView to enable and handle Picture-In-Picture mode.

Do not invoke the functions of the implementing class on your own. PlayerView will handle them (after setting the handler via PlayerView.setPictureInPictureHandler).

Properties

isPictureInPicture

abstract val isPictureInPicture: Boolean

Whether the view is currently in Picture-In-Picture (PiP) mode.

isPictureInPictureAvailable

abstract val isPictureInPictureAvailable: Boolean

Whether Picture-In-Picture (PiP) mode is available.

Functions

enterPictureInPicture

abstract fun enterPictureInPicture()

Puts the view into Picture-In-Picture (PiP) mode. Has no effect if isPictureInPictureAvailable is false or if the view is already in PiP mode.

exitPictureInPicture

abstract fun exitPictureInPicture()

Pulls the view out of Picture-In-Picture (PiP) mode. Has no effect if isPictureInPictureAvailable is false or if the view is currently not in PiP mode.