Interface InternalUIConfig

Specifies if the UI variants should be resolved and switched automatically upon certain player events. The default is true. Should be set to false if purely manual switching through UIManager.resolveUiVariant is desired. A hybrid approach can be used by setting this to true (or leaving the default) and overriding automatic switches through a UIManager.onUiVariantResolve event handler.

The rendered player height threshold in pixels at or below which small-player adjustments are applied to CEA-608 captions:

1. The caption overlay is constrained to a centered 80% safe area (proportional margins on all four sides), replacing the fixed em-based margins used at larger sizes.
2. The controlbar pushup is disabled, keeping captions anchored to the safe area regardless of controlbar state.

"Rendered height" refers to the actual on-screen height of the player DOM element in CSS pixels, not the video resolution.

At small player sizes fixed em margins take up a disproportionate share of the available space, and pushing captions up when the controlbar appears can make them illegible. The 80% safe area and the suppressed pushup together keep CEA-608 captions legible and correctly positioned at these sizes.

Set to 0 to disable both adjustments for all player sizes (restoring the default large-player behaviour everywhere).

Default: 360

Allows overriding component-specific config without building a custom UI layout through the UIFactory. Component-specific config can be specified by the public component class name.

Top-level entries apply to all UI variants. Entries nested under a UIVariantIdentifier only apply to that variant and override top-level component config. Component keys can be any public component class that extends Component. Base component keys also apply to subclasses, for example a ToggleButton config applies to FullscreenToggleButton, VolumeToggleButton, and other toggle buttons unless a more specific component key overrides it.

Specifies the container in the DOM into which the UI will be added. Can be a CSS selector string or a HTMLElement object. By default, the player container will be used (PlayerAPI#getContainer).

Specifies if the player controls including SettingsPanel should auto hide when still hovered. This configuration does not apply to devices using a touch screen. On touch screen devices the SettingsPanel is by default configured to not auto-hide and the behaviour cannot be changed using this configuration. Default: false

If set to true, prevents the UI from using localStorage.

Specifies if the EcoModeToggleButton should be displayed within the SettingsPanel

If set to true, the UI persists volume, mute state, and playback speed across sessions and reapplies them when a player using this UI is initialized — automatically, without any end-user interaction. Use showPersistentPreferencesToggle instead (or in addition) to delegate the decision to the end-user via a settings-panel toggle.

Has no effect when disableStorageApi is true or localStorage is unavailable.

Disabled by default so existing integrations (including automated tests and custom persistence layers) are not affected. Opt in explicitly per UI instance.

Default: false

Toggles the seek preview feature. Default: true

If set to true, the UI parses a t=<seconds>[s] parameter from the page URL (either the query string or the URL fragment) and seeks to that time on the first SourceLoaded event. This is the consumer side of the "Copy link at current time" context-menu action. Has no effect on live streams.

Default: true

Specifies if the player should enter fullscreen by clicking on the PlaybackToggleButton, HugePlaybackToggleButton, or PlaybackToggleOverlay when attempting the initial playback start. Default: false

Provide customized errorMessages For an example have a look at ErrorMessageOverlayConfig.messages

Forces subtitle-labels back into their respective container if they overflow and are therefore cropped.

Specifies if the Watermark element should be included in the UI. Per default, the Watermark shows the Bitmovin Logo.

Default: false

Allows setting a LocalizationConfig to specify language details of the UI.

Specifies UI metadata displayed or used by UI components.

Specifies if the PlaybackSpeedSelectBox should be displayed within the SettingsPanel Default: true

Whether the play head should snap to markers on the seek bar when seeking sufficiently near them.

The related config option seekbarSnappingRange defines the tolerance that is used to determine whether a seek time hits a marker.

Note:

• When hitting a point marker (i.e. one without duration), the play head would snap to the exact time of the marker.
• Likewise, when hitting a range marker (i.e. one with duration) which effectively snaps to the start of the time range that it defines.

Default: true

Specifies the seek bar marker snapping tolerance in percent. This option has no effect if seekbarSnappingEnabled is set to false. Default: 1

Configure Shadow DOM rendering. Enable it with: shadowDom: true shadowDom: { enabled: true } (especially if you need to set more configuration options)

Enable ShadowDom rendering to prevent CSS from an enclosing website to interfere with the UI styles. Check the availability here: https://caniuse.com/shadowdomv1.

Default: false

If set to true, the settings panel shows an opt-in toggle that lets the end-user decide whether the UI persists volume, mute state, and playback speed across sessions. The user's choice is itself persisted; when enablePersistentPreferences is also set, it provides the toggle's initial (on) state until the user changes it.

Has no effect when disableStorageApi is true or localStorage is unavailable.

Default: false