player-ui-web/com.bitmovin.player.api.ui/UiConfig/WebUi

WebUi

data class WebUi(val cssLocation: String = "file:///android_asset/bitmovinplayer-ui.css", val supplementalCssLocation: String? = null, val jsLocation: String = "file:///android_asset/bitmovinplayer-ui.js", val playbackSpeedSelectionEnabled: Boolean = true, val forceSubtitlesIntoViewContainer: Boolean = true, val customOptions: String? = null, val variant: UiConfig.WebUi.Variant = Variant.SmallScreenUi, val focusUiOnInitialization: Boolean = variant == Variant.TvUi) : UiConfig

Configures the visual presentation and behaviour of the Bitmovin Web UI.

The Web UI is hosted in a WebView. For debugging the Web UI, it is possible to set WebView.setWebContentsDebuggingEnabled in code or android:debuggable="true" in the app manifest to enable debugging of all WebView contents i.e. globally for the app.

Constructors

Link copied to clipboard
constructor(cssLocation: String = "file:///android_asset/bitmovinplayer-ui.css", supplementalCssLocation: String? = null, jsLocation: String = "file:///android_asset/bitmovinplayer-ui.js", playbackSpeedSelectionEnabled: Boolean = true, forceSubtitlesIntoViewContainer: Boolean = true, customOptions: String? = null, variant: UiConfig.WebUi.Variant = Variant.SmallScreenUi, focusUiOnInitialization: Boolean = variant == Variant.TvUi)

Types

Link copied to clipboard
sealed class Variant

Properties

Link copied to clipboard
val cssLocation: String

The URI pointing to the CSS file that will be used for the Bitmovin Web UI. Default value is "file:///android_asset/bitmovinplayer-ui.css", using the local default UI style.

Link copied to clipboard
val customOptions: String? = null

Additional JSON-serialized options to use when creating the Bitmovin Player Web UI. These options will be set in the Bitmovin Player Web UI's JavaScript context, on the UIConfig type, before being passed to UIFactory.

Link copied to clipboard
val focusUiOnInitialization: Boolean

Whether the WebView should be focused on initialization.

Link copied to clipboard
val forceSubtitlesIntoViewContainer: Boolean = true

When set to true the Bitmovin Player Web UI forces subtitles back into their respective container if they overflow and are therefore cropped.

Link copied to clipboard
val jsLocation: String

The URI pointing to the JS file that will be used for the Bitmovin Web UI. Default value is "file:///android_asset/bitmovinplayer-ui.js", using the local default UI JS.

Link copied to clipboard
val playbackSpeedSelectionEnabled: Boolean = true

Whether the Bitmovin Web UI will show playback speed selection options in the settings menu. Default is true.

Link copied to clipboard
val supplementalCssLocation: String? = null

The URI pointing to the supplemental CSS file that will be used for the Bitmovin Web UI. The contained styles will be added to the CSS file specified in cssLocation. Default is null.

Link copied to clipboard
val variant: UiConfig.WebUi.Variant

The Ui variant to use for the Bitmovin Player Web UI.