BitmovinUserInterfaceConfig

Contains config values that can be used to alter the visual presentation and behaviour when the Bitmovin Player Web UI is used.

  • Handles the communication with the Bitmovin Web UI in both directions

  • When set to true the first frame of the main content will not be rendered before playback starts. Default is false.

    To reliably hide the first frame before a pre-roll ad, please ensure that you are using the AdvertisingConfig to schedule ads and not the scheduleAd API call.

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

    This flag directly maps to the UIConfig.forceSubtitlesIntoViewContainer of our Bitmovin Player Web UI.

    Default is true.

  • When set to true the Bitmovin Player Web UI will show the playback speed selection option in the settings menu.

    Default is true.

  • When set to true the Bitmovin Player Web UI will update video frames while scrubbing the seek bar.

    Default is true.

  • When set to true the WKWebView used for the Bitmovin Player Web UI can be inspected using the Safari Web Inspector. See Enabling the Inspection of Web Content in Apps for details.

    This value has no effect below iOS 16.4 where inspecting WKWebViews is always enabled.

    We recommend to only enable this in DEBUG builds. If enabled in released Apps, everyone could inspect the WKWebView on their devices.

    Default is false.

  • Metadata to use as fallback when currently active source has no respective value set.

  • Additional options to use when creating the Bitmovin Player Web UI. These will be set in the Bitmovin Player Web UI’s JavaScript context, on type UIConfig, before passing it to UIFactory.

    This can be useful when using a custom build of Bitmovin Player Web UI and provide custom configuration options.

    Important

    Values set here replace any previously set value for the same property on UIConfig.

    Warning

    All values must be serializable via JSONSerialization.data(withJSONObject:options:). This can be checked via testing with JSONSerialization.isValidJSONObject(_:). In case any of the values can not be serialized, customOptions will be ignored.

    Default is empty dictionary.

  • Specifies the function name that will be used to initialize the UIManager for the the Bitmovin Player Web UI.

    The function will be called on the window object with the Player as the first argument and the UIConfig as the second argument.

    Example: When you added a new function or want to use a different function of our UIFactory, you can specify the full qualifier name including namespaces. See the default value for an example.

    Notes:

    • It’s not necessary to use our UIFactory. Any static function can be specified.
    • We expect that the function returns an instance of type UIManager.

    Default value is bitmovin.playerui.UIFactory.buildDefaultSmallScreenUI.