Class MKCustomUI

A utility/wrapper class that centralizes all Bitmovin UI factory varians 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.

Hierarchy

  • MKCustomUI

Constructors

constructor

Methods

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

Constructors

constructor

  • 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

  • Builds the default UI for Chromecast Receiver apps.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildDefaultSmallScreenUI

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

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildDefaultTvUI

  • Builds the default UI specifically for TV devices.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildDefaultUI

  • Builds the general default UI.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildModernCastReceiverUI

  • Builds the new modern-style UI for cast receivers.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildModernSmallScreenUI

  • Builds the modern user interface for small screens.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

buildModernTvUI

  • Builds the modern UI for TV environments.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containingUIManager

buildModernUI

  • Builds the general modern UI layout.

    Parameters

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

customUi

  • 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

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

customUiVariant

  • 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

    • Optional config: UIConfig

      Optional UIConfig

    Returns UIManager

    an object containing UIManager

modernAdsUI

  • Produces only the modern-style ads container UI.

    Returns UIContainer

    a UIContainer instead of a full UIManager.

modernCastReceiverUI

  • Modern UI structure for cast receivers.

    Returns CastUIContainer

    a CastUIContainer instead of a full UIManager.

modernSmallScreenAdsUI

  • Modern layout for ads on small screens.

    Returns UIContainer

    a UIContainer instead of a full UIManager.

modernSmallScreenUI

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

    Returns UIContainer

    a UIContainer instead of a full UIManager.

modernTvAdsUI

  • Modern TV ads UI with spatial navigation support.

    Returns {
        spatialNavigation: SpatialNavigation;
        uiContainer?: UIContainer;
    }

    SpatialNavigation and UIContainer

    • spatialNavigation: SpatialNavigation
    • Optional uiContainer?: UIContainer

modernTvUI

  • Modern TV UI with spatial navigation controls.

    Returns {
        spatialNavigation: SpatialNavigation;
        uiContainer?: UIContainer;
    }

    SpatialNavigation and UIContainer

    • spatialNavigation: SpatialNavigation
    • Optional uiContainer?: UIContainer

modernUI

  • 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

Theme

On This Page