[object Object] Icon

Encoding
Learn how to create, start, manage and modify Encodings

[object Object] Icon

Player
Learn how to create, start, manage and modify Players

[object Object] Icon

Analytics
Learn how to create, start, manage and modify Analyticss

Docs Home
User shortcuts for search
Focus by pressing f
Hide results by pressing Esc
Navigate via   keys

Wed Sep 19 2018

Player UI CSS Class Reference

Wed Sep 19 2018

IntroductionLink Icon

This document provides a list of all the CSS classes used for the default skin, which can be used to customize the Bitmovin Player look&feel. Since V7, skinning is purely CSS based and the UI is built upon our open-source UI framework. Because this framework allows great flexibility in UI design, configuration and layout, this document only applies to the default skin, that is shipped with the Bitmovin Player.

Experienced developers may want to directly develop into the SCSS sources. Developers that want to build a custom UI are encouraged to read the technical documentation in the GitHub repository.

UI ContainerLink Icon

The UI container is the root DOM element of the UI that contains all other UI elements, a div with class .bmpui-ui-uicontainer. It always reflects the player’s playback state through state classes and carries additional flags reflecting UI states. All of these classes can be used to adjust the UI to certain states, e.g. by showing or hiding certain elements that belong to certain states. For example if the player is in the finished state, it might make sense to hide the control bar and display a restart button instead.

Player StatesLink Icon

This are the global states of the player, which is always in one of these states: Player States

StateCSS ClassDescription
IDLE.bmpui-player-state-idleNo source is loaded in the player. Loading a source transitions to the PREPARED state, unloading a source in any state transitions back to the IDLE state.
PREPARED.bmpui-player-state-preparedA source is loaded, but playback has not been started yet. Starting playback for the first time transitions to the PLAYING state. Loading a new source in any state transitions to PREPARED state.
PLAYING.bmpui-player-state-playingPlayback is running. Pausing transitions to PAUSED state.
PAUSED.bmpui-player-state-pausedPlayback is paused. Playing transitions to PLAYING state.
FINISHED.bmpui-player-state-finishedPlayback has finished, the end of the source has been reached.

FlagsLink Icon

StateCSS ClassDescription
FLEXBOX.bmpui-flexbox
.bmpui-no-flexbox
Added depending on flexbox support of the browser. Can be used for IE9 compatibility style tweaks.
FULLSCREEN.bmpui-fullscreenAdded when the player enters fullscreen mode, removed when it exits fullscreen mode.
BUFFERING.bmpui-bufferingAdded while the player is buffering content.
CONTROLS.bmpui-controls-shown
.bmpui-controls-hidden
Toggled depending on if the UI should be visible or hidden.

Responsive LayoutLink Icon

Since CSS media queries are only applicable to the document and not to the player element, they cannot be nicely used to dynamically adjust the UI layout based on the player size. To enable responsive layouts, the UI container attaches specific classes depending on the player size.

CSS ClassDescription
.bmpui-layout-max-width-400Player width is <= 400 pixels.
.bmpui-layout-max-width-600Player width is > 400 and <= 600 pixels.
.bmpui-layout-max-width-800Player width is > 600 and <= 800 pixels.
.bmpui-layout-max-width-1200Player width is > 800 and <= 1200pixels.

FontLink Icon

The default font is set to sans-serif. To adjust the font, simply set the CSS font-family on the UI container. Similarly, set font-size to adjust the font size. All sizes in the UI are relative (specified in em units), so the size of the UI elements will scale with your font size.

1.bmpui-ui-uicontainer {
2 font-family: 'Roboto';
3 font-size: 10pt;
4}

Style namespaceLink Icon

All styles of a skin are namespaced with a class on the UI container. The namespace class for the default skin is .bmpui-ui-skin-modern.

The namespace can be useful to reference multiple skin styles from a web page and switch between them. To just tweak the default style, you don’t need to take care about the namespace.

Example: Take a look at the following DOM excerpt:

1<div id="bmpui-id-1"
2 class="bmpui-ui-uicontainer
3 bmpui-ui-skin-modern
4 bmpui-flexbox
5 bmpui-player-state-prepared
6 bmpui-fullscreen
7 bmpui-controls-hidden">
8 ...
9</div>

What does it tell us? It tells us that the default skin was used, that the browser that rendered this DOM supports flexbox, a source was loaded in the player but playback was not yet started, the player is in fullscreen mode, and the controls should be hidden. As a skinner, you can react to these states in CSS, e.g. by displaying a play button overlay that is only shown while playback has not yet been started, and by making sure that the controls (control bar, title bar) are not visible.

UI LayoutsLink Icon

The default skin provides different layouts for different use-cases. Styling of these layouts is done through sub-namespaces applied to the UI container (e.g. .bmpui-ui-uicontainer.bmpui-ui-skin-modern.bmpui-ui-skin-ads).

CSS ClassDescription
.bmpui-ui-skin-adsStyle adjustments for the ads UI that is shown during playback of certain ads.
.bmpui-ui-skin-cast-receiverStyle adjustments for the Google Cast receiver UI.
.bmpui-ui-skin-smallscreenStyle adjustments for the slimmed-down UI for small screens (e.g. smartphones). Not in use yet.

UI ElementsLink Icon

This section lists all elements of the default skin and their classes to style them. All classes are prefixed with bmpui- to avoid classname clashes with the websites where the player is embedded. Elements can either be functional UI components or plain DOM elements. Functional UI components are components of the UI framework and can be identified by the prefix ui- (e.g. .bmpui-ui-seekbar). They carry various additional state classes. Plain DOM elements are usually child elements of a component that make up the structure of the component. They do not have any functionality on their own and do not have the ui- class prefix identifier (e.g. .bmpui-seekbar-playbackposition).

All UI components can be hidden and will have the .bmpui-hidden class attached when they are, respectively should be, hidden.

LabelsLink Icon

Labels are components that display text. They do not have any additional state classes. Additional labels will be described in the following sections.

CSS ClassDescription
.bmpui-ui-playbacktimelabelDisplays the current playback time or the total duration. Has state class .bmpui-ui-playbacktimelabel-live if the playback media is a live stream, and .bmpui-ui-playbacktimelabel-live-edge if playback is at the live edge.
.bmpui-ui-subtitle-labelDisplays the actual subtitle text on the subtitle overlay.
.bmpui-ui-cast-status-labelDisplays the status of an ongoing Cast session on the Cast overlay.
.bmpui-ui-errormessage-labelDisplays an error message on the error message overlay.

ButtonsLink Icon

Buttons trigger an action and come in two variations: buttons and toggle buttons. Toggle buttons switch between an on and off state, signaled by the .bmpui-on and .bmpui-off state classes. A freshly initialized button that has never been triggered is in neither state. Icons on the buttons are set with background-image properties.

CSS ClassDescription
.bmpui-ui-playbacktogglebuttonToggles the playback state between playing and paused.
.bmpui-ui-volumetogglebuttonToggles audio between muted and unmuted. Has the .bmpui-low state class when audio is unmuted and volume below 50%.
.bmpui-ui-casttogglebuttonToggles between local playback and casting to Cast receiver.
.bmpui-ui-vrtogglebuttonToggles the VR mode.
.bmpui-ui-settingstogglebuttonToggles the visibility of the settings panel.
.bmpui-ui-fullscreentogglebuttonToggles between windowed and fullscreen mode.
.bmpui-ui-hugeplaybacktogglebuttonBig button that toggles the playback state between playing and paused. Part of the playback toggle overlay.
.bmpui-ui-hugereplaybuttonBig button with a replay icon to start playback from the beginning. Part of the recommendation overlay.

Seek BarLink Icon

The seek bar is the component that displays the playback position and buffer level on a graphical timeline. It provides means to seek within the playback media and displays tumbnail previews at the seek target position.

CSS ClassDescription
.bmpui-ui-seekbarShows the playback position and makes it possible to seek within the playback media.
.bmpui-seekbar-backdropBackdrop of all indicator bars.
.bmpui-seekbar-bufferlevelBar that indicates the buffer level.
.bmpui-seekbar-seekpositionBar that previews the target of a seek operation while the seekbar is hovered.
.bmpui-seekbar-playbackpositionBar that indicates the current playback position.
.bmpui-seekbar-playbackposition-markerMarker on the right edge of the playback position bar.
.bmpui-seekbar-markersContainer for timeline markers on the seekbar.
.bmpui-seekbar-markers .bmpui-seekbar-markerA marker on the seekbar that marks a point in time (e.g. ad markers, chapter markers).
.bmpui-ui-seekbar-labelElement that is shown above the seek position when the seekbar is hovered. Shows the time at the seek position and a thumbnail if available.
.bmpui-ui-seekbar-label .bmpui-seekbar-thumbnailDisplays the seek thumbnail in the seekbar label.
.bmpui-ui-seekbar-label .bmpui-seekbar-label-timeDisplays the time at the seek position.
.bmpui-ui-seekbar-label .bmpui-seekbar-label-titleDisplays the title (e.g. a chapter marker title) at the current seek position.

Volume SliderLink Icon

The volume slider is a subclass of the seek bar that makes partial use of seek bar’s functionality and shares the same class names of the inner elements. Styles must therefore be namespaced with the volumeslider class.

CSS ClassDescription
.bmpui-ui-volumesliderShows the current volume setting and makes it possible to set the volume by adjusting the slider.
.bmpui-ui-volumeslider .bmpui-seekbar-seekpositionBar that indicates the target volume while the silder is hovered.
.bmpui-ui-volumeslider .bmpui-seekbar-playbackpositionBar that indicates the current volume setting.
.bmpui-ui-volumeslider .bmpui-seekbar-playbackposition-markerMarker on the right edge of the volume bar.

Control BarLink Icon

The control bar is the main component of the player and contains all important elements to control playback.

CSS ClassDescription
.bmpui-ui-controlbarContainer on the bottom edge that contains playback controls.
.bmpui-ui-container.bmpui-controlbar-topContainer within the control bar that contains the top row of controls, e.g. the seek bar.
.bmpui-ui-container.bmpui-controlbar-bottomContainer within the control bar that contains the bottom row of controls, e.g. the playback toggle button.

Title BarLink Icon

The title bar displays metadata about the current playback media.

CSS ClassDescription
.bmpui-ui-titlebarContainer on the top edge that contains title metadata.
.bmpui-ui-titlebar-titleLabel that displays the title of the playback media.
.bmpui-ui-titlebar-descriptionLabel that displays the description of the playback media.

OverlaysLink Icon

Overlays cover the whole player window. Depending on their functionality, they are above or below the playback controls layer.

CSS ClassDescription
.bmpui-ui-subtitle-overlayDisplays subtitles above the playback media.
.bmpui-ui-buffering-overlayDisplays a buffering indicator above the playback media while the player is buffering.
.bmpui-ui-playbacktoggle-overlayDisplays a huge button that toggles play/pause over the whole player window.
.bmpui-ui-cast-status-overlayDisplays the status of a Cast session over the whole player window.
.bmpui-ui-recommendation-overlayDisplays a replay button and optional recommendations at the end of playback.
.bmpui-ui-watermarkDisplays a clickable watermark image above the playback media.
.bmpui-ui-errormessage-overlayDisplays an error message over the whole player window when a critical error happens.
.bmpui-ui-clickoverlayCatches clicks on the player window and opens a configured URL in a new tab if clicked. Used for ads.

Settings PanelLink Icon

The settings panel opens when the settings toggle button is clicked and displays avialable options that the user can change.

CSS ClassDescription
.bmpui-ui-settings-panelContains all configurable player settings.
.bmpui-ui-settings-panel-itemContains a label and selectbox of a specific settings item.
.bmpui-ui-settings-panel-item .bmpui-ui-labelDisplays the label of a selectbox.
.bmpui-ui-settings-panel-item .bmpui-ui-selectboxSelectbox to choose between different options (video quality, speed, audio track, audio quality, subtitles).

VariousLink Icon

CSS ClassDescription
.bmpui-ui-containerGeneric container component that can contain multiple child components.
.bmpui-container-wrapperInner container element of a container component that contains the actual child components. This inner element in conjunction with the outer container element is often useful for advances styling an animation.
.bmpui-ui-buffering-overlay-indicatorThe buffering overlay contains 3 such indicator elements to animate a buffering progress indicator.
.bmpui-ui-recommendation-itemAn anchor element linking to a recommendation. Contains inner elements with classes .bmpui-background, .bmpui-title, .bmpui-duration that display the background thumbnail image, the title and the duration of the recommendation.
.bmpui-ui-tvnoisecanvasA canvas that renders animated TV noise. Used as backdrop of the error message overlay.

AdsLink Icon

These special components are used for the ads UI, a second separate UI instance that is displayed while an ad is playing that permits the UI. The ads UI container is a .bmpui-ui-uicontainer with the additional .bmpui-ui-skin-ads class.

CSS ClassDescription
.bmpui-ui-ads-statusContainer for ads-related components.
.bmpui-ui-clickoverlayAd click overlay that captures clicks on ads and, depending on the ad config, opens the clickthrough url in a new tab. This component is invisible and does not receive any styling, therefore it does not have a distinct class but inherits its class from the click overlay.
.bmpui-ui-label-ad-messageLabel that displays an ad message during ad playback.
.bmpui-ui-button-ad-skipButton that displays an ad countdown message or an ad skip message once the ad can be skipped.

AnimationsLink Icon

The default skin animates some components of the UI. The animations are just CSS transition or animationproperties, and can be easily discovered and inspected with a browser’s developer tools. To change or disable an animation, just overwrite the property of the appropriate class.

Disabling the animations of the play/pause overlay button can be done as follows:

1// Disable the pulsate animation when the button is hovered and playback has not been started
2.bmpui-ui-hugeplaybacktogglebutton .bmpui-image:hover {
3 animation: none;
4}
5// Disable the fade-out animation when playback starts
6.bmpui-ui-hugeplaybacktogglebutton.bmpui-on .bmpui-image {
7 animation: none;
8}
9// Disable the fade-in animation when playback pauses
10.bmpui-ui-hugeplaybacktogglebutton.bmpui-off .bmpui-image {
11 animation: none;
12}

Overriding StylesLink Icon

To overwrite default styles with your own values, you can put them anywhere you would normally put CSS styles (i.e. external .css file or inline <style> block). When using blogging platforms or content management systems (e.g. WordPress), there is usually functionality or plugins for placing custom CSS styles available.

When overwriting CSS styles, you need to take care of CSS specificity. In CSS, the most specific CSS selector counts, and if your custom styles are not applied to the skin although the style definitions are correct, this is probably the reason to look out for. The Bitmovin Player is usually instanciated with a unique id of a div (e.g. <div id="player"></div>), and this id is usually specific enough to overwrite styles. The CSS for overwriting the font and disabling animations of the play button overlay (as shown in the sections above) would thus look like this:

1#player .bmpui-ui-uicontainer {
2 font-family: 'Roboto';
3 font-size: 10pt;
4}
5#player .bmpui-ui-hugeplaybacktogglebutton .bmpui-image:hover {
6 animation: none;
7}
8#player .bmpui-ui-hugeplaybacktogglebutton.bmpui-on .bmpui-image {
9 animation: none;
10}
11#player .bmpui-ui-hugeplaybacktogglebutton.bmpui-off .bmpui-image {
12 animation: none;
13}

Styling Chromecast Receiver AppsLink Icon

A URL to a CSS file can be passed to the player. The receiver app will load this CSS file to apply styling information. Details can be found in the Cast configuration documentation of the player.

Give us feedback