UserInterfaceApi

interface UserInterfaceApi

API methods related to the user interface.

Functions

enterFullscreen

abstract fun enterFullscreen()

The player enters fullscreen mode.

enterPictureInPicture

abstract fun enterPictureInPicture()

The player enters Picture-In-Picture (PiP) mode.

exitFullscreen

abstract fun exitFullscreen()

The player exits fullscreen mode.

exitPictureInPicture

abstract fun exitPictureInPicture()

The player exits Picture-In-Picture (PiP) mode.

getPlayer

@Nullable()

abstract fun getPlayer(): Player

Returns the player instance currently used by this interface.

getScalingMode

abstract fun getScalingMode(): ScalingMode

Returns the current `ScalingMode`.

isFullscreen

abstract fun isFullscreen(): Boolean

Returns {@code true} if the player is currently in fullscreen mode.

isPictureInPicture

abstract fun isPictureInPicture(): Boolean

Returns {@code true} if player is currently in Picture-in-Picture (PiP) mode.

isPictureInPictureAvailable

abstract fun isPictureInPictureAvailable(): Boolean

Returns {@code true} if current device supports Picture-In-Picture (PiP) mode.

isUiVisible

abstract fun isUiVisible(): Boolean

Returns if the UI is currently visible.

setCustomMessageHandler

abstract fun setCustomMessageHandler(customMessageHandler: CustomMessageHandler)

Set a CustomMessageHandler which handles the communication with the Bitmovin Web UI in both directions

setPlayer

abstract fun setPlayer(@Nullable() player: Player)

Sets the Player instance, for which the UI acts.

setPosterImage

abstract fun setPosterImage(url: String, keepPersistent: Boolean)

Sets a poster image which will be displayed before playback starts.

setScalingMode

abstract fun setScalingMode(scalingMode: ScalingMode)

Sets a new `ScalingMode`.

setUiVisible

abstract fun setUiVisible(visible: Boolean)

Sets if the UI should be visible or not.

Inheritors

PlayerView