Optional
autoOptional
containerSpecifies 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).
Optional
disableSpecifies 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
Optional
disableIf set to true, prevents the UI from using localStorage
.
Optional
ecoSpecifies if the EcoModeToggleButton
should be displayed within the SettingsPanel
Optional
enableToggles the seek preview feature. Default: true
Optional
enterSpecifies if the player should enter fullscreen by clicking on the PlaybackToggleButton
,
HugePlaybackToggleButton
, or PlaybackToggleOverlay
when attempting the initial playback start.
Default: false
Optional
errorProvide customized errorMessages For an example have a look at ErrorMessageOverlayConfig.messages
Optional
forceForces subtitle-labels back into their respective container if they overflow and are therefore cropped.
Optional
metadataOptional
playbackSpecifies if the PlaybackSpeedSelectBox
should be displayed within the SettingsPanel
Default: true
Optional
recommendationsOptional
seekbarWhether 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:
Default: true
Optional
seekbarSpecifies the seek bar marker snapping tolerance in percent. This option has no effect if seekbarSnappingEnabled
is set to false.
Default: 1
Specifies if the UI variants should be resolved and switched automatically upon certain player events. The default is
true
. Should be set tofalse
if purely manual switching through UIManager.resolveUiVariant is desired. A hybrid approach can be used by setting this totrue
(or leaving the default) and overriding automatic switches through a UIManager.onUiVariantResolve event handler.