Class MKCustomUI

A utility/wrapper class that centralizes all Bitmovin UI factory variants and UIManager instantiation.

This allows you to build default, modern, or custom UI layouts for various device types (cast, TV, mobile, etc.) while keeping configuration inside a single class.

Constructors

constructor

Methods

buildDefaultCastReceiverUI buildDefaultSmallScreenUI buildDefaultTvUI buildDefaultUI buildModernCastReceiverUI buildModernSmallScreenUI buildModernTvUI buildModernUI customUi customUiVariant modernAdsUI modernCastReceiverUI modernSmallScreenAdsUI modernSmallScreenUI modernTvAdsUI modernTvUI modernUI

Constructors

constructor

  • new MKCustomUI(player: any): MKCustomUI

    Receives the main player instance and extracts the Bitmovin internal engine which is required by every UIFactory and UIManager call.

    Parameters

    • player: any

      The MKPlayer instance

    Returns MKCustomUI

Methods

buildDefaultCastReceiverUI

  • buildDefaultCastReceiverUI(config?: UIConfig): UIManager

    Builds the default UI for Chromecast Receiver apps.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildDefaultSmallScreenUI

  • buildDefaultSmallScreenUI(config?: UIConfig): UIManager

    Builds the default UI optimized for small screens (mobile).

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildDefaultTvUI

  • buildDefaultTvUI(config?: UIConfig): UIManager

    Builds the default UI specifically for TV devices.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildDefaultUI

  • buildDefaultUI(config?: UIConfig): UIManager

    Builds the general default UI.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildModernCastReceiverUI

  • buildModernCastReceiverUI(config?: UIConfig): UIManager

    Builds the new modern-style UI for cast receivers.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildModernSmallScreenUI

  • buildModernSmallScreenUI(config?: UIConfig): UIManager

    Builds the modern user interface for small screens.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildModernTvUI

  • buildModernTvUI(config?: UIConfig): UIManager

    Builds the modern UI for TV environments.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containingUIManager

buildModernUI

  • buildModernUI(config?: UIConfig): UIManager

    Builds the general modern UI layout.

    Parameters

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

customUi

  • customUi(uiContainer: UIContainer, config?: UIConfig): UIManager

    Allows providing your own UIContainer and building a full UIManager. This bypasses UIFactory layouts and gives full customization control.

    Parameters

    • uiContainer: UIContainer

      A custom UIContainer instance

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

customUiVariant

  • customUiVariant(uiVariants: UIVariant[], config?: UIConfig): UIManager

    Allows providing multiple UI variants (responsive UIs) to the UIManager. The player will switch UI based on screen size, device type, or custom rules.

    Parameters

    • uiVariants: UIVariant[]

      Array of UIVariant objects

    • Optionalconfig: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

modernAdsUI

  • modernAdsUI(): UIContainer

    Produces only the modern-style ads container UI.

    Returns UIContainer

    a UIContainer instead of a full UIManager.

modernCastReceiverUI

  • modernCastReceiverUI(): CastUIContainer

    Modern UI structure for cast receivers.

    Returns CastUIContainer

    a CastUIContainer instead of a full UIManager.

modernSmallScreenAdsUI

  • modernSmallScreenAdsUI(): UIContainer

    Modern layout for ads on small screens.

    Returns UIContainer

    a UIContainer instead of a full UIManager.

modernSmallScreenUI

  • modernSmallScreenUI(): UIContainer

    Creates the modern UI layout optimized for small screens (no UIManager).

    Returns UIContainer

    a UIContainer instead of a full UIManager.

modernTvAdsUI

  • modernTvAdsUI(): {
        spatialNavigation: SpatialNavigation;
        uiContainer?: UIContainer;
    }

    Modern TV ads UI with spatial navigation support.

    Returns { spatialNavigation: SpatialNavigation; uiContainer?: UIContainer }

    SpatialNavigation and UIContainer

modernTvUI

  • modernTvUI(): {
        spatialNavigation: SpatialNavigation;
        uiContainer?: UIContainer;
    }

    Modern TV UI with spatial navigation controls.

    Returns { spatialNavigation: SpatialNavigation; uiContainer?: UIContainer }

    SpatialNavigation and UIContainer

modernUI

  • modernUI(config: UIConfig): UIContainer

    General modern UI container structure. Does NOT attach it to the player automatically.

    Parameters

    • config: UIConfig

    Returns UIContainer

    a UIContainer instead of a full UIManager.

Settings

Member Visibility

On This Page

Constructors
Methods