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

UserInterfaceApi

interface UserInterfaceApi

API methods related to the user interface.

Inheritors

Functions

Link copied to clipboard
abstract fun enterFullscreen()
The player enters fullscreen mode.
Link copied to clipboard
abstract fun enterPictureInPicture()
The player enters Picture-In-Picture (PiP) mode.
Link copied to clipboard
abstract fun exitFullscreen()
The player exits fullscreen mode.
Link copied to clipboard
abstract fun exitPictureInPicture()
The player exits Picture-In-Picture (PiP) mode.
Link copied to clipboard
@Nullable
abstract fun getPlayer(): Player
Returns the player instance currently used by this interface.
Link copied to clipboard
abstract fun getScalingMode(): ScalingMode
Returns the current `ScalingMode`.
Link copied to clipboard
abstract fun isFullscreen(): Boolean
Returns true if the player is currently in fullscreen mode.
Link copied to clipboard
abstract fun isPictureInPicture(): Boolean
Returns true if player is currently in Picture-in-Picture (PiP) mode.
Link copied to clipboard
abstract fun isPictureInPictureAvailable(): Boolean
Returns true if current device supports Picture-In-Picture (PiP) mode.
Link copied to clipboard
abstract fun isUiVisible(): Boolean
Returns if the UI is currently visible.
Link copied to clipboard
abstract fun setCustomMessageHandler(customMessageHandler: CustomMessageHandler)
Set a CustomMessageHandler which handles the communication with the Bitmovin Web UI in both directions
Link copied to clipboard
abstract fun setPlayer(@Nullable player: Player)
Sets the Player instance, for which the UI acts.
Link copied to clipboard
abstract fun setPosterImage(url: String, keepPersistent: Boolean)
Sets a poster image which will be displayed before playback starts.
Link copied to clipboard
abstract fun setScalingMode(scalingMode: ScalingMode)
Sets a new `ScalingMode`.
Link copied to clipboard
abstract fun setUiVisible(visible: Boolean)
Sets if the UI should be visible or not.