Brightcove Player Sample: Full Window Background Video

Product(s)
Video Cloud
Brightcove Player
Role(s)
Player Developer

In this topic, you will learn how to use a playlist to supply background videos, and automatically resize the player when the browser window is resized so that the video entirely fills the browser window.

Introduction

In the player you will see there are four videos that continually play as background videos. Also, at the start of each video the title and description of each video are displayed overlaying the background video. This sample is functionally identical to this background video sample, except that here the video fills the entire window, regardless of how the browser window is sized or resized. to get a sense of this, you can resize the Codepen below by clicking and dragging from the lower-right corner:

Resize Codepen
Resize Codepen

Note that this solution depends on a CSS property that may not be supported on older browsers - to make it work on all browsers, you can use the workaround explained here.

Player example

See the Pen Full Window Background Video Playlist by Brightcove Learning Services (@rcrooks1969) on CodePen.

View the source code.

Using the CodePen

Here are some tips to effectively use the above CodePen:

  • Toggle the actual display of the player by clicking the Result button.
  • Click the HTML/CSS/JS buttons to display ONE of the code types.
  • Later in this document the logic, flow and styling used in the application will be discussed in the Player/HTML configuration, Application flow and Application styling sections. The best way to follow along with the information in those sections is to:
    1. Click the EDIT ON CODEPEN button in the CodePen and have the code available in one browser/browser tab.
    2. In CodePen, adjust what code you want displayed. You can change the width of different code sections within CodePen.
    3. View the Player/HTML configuration, Application flow and/or Application styling sections in another browser/browser tab. You will now be able to follow the code explanations and at the same time view the code.

Development sequence

Here is the recommended development sequence:

  1. Use the In-Page embed player implementation to test the functionality of your player, plugin and CSS (if CSS is needed)
  2. Put the plugin's JavaScript and CSS into separate files for local testing
  3. Deploy the plugin code and CSS to your server once you have worked out any errors
  4. Use Studio to add the plugin and CSS to your player
  5. Replace the In-Page embed player implementation if you determine that the iframe implementation is a better fit (detailed in next section)

For details about these steps, review the Quick Start: Plugin Development guide.

iframe or In-Page embed

When developing enhancements for the Brightcove player you will need to decide if the code is a best fit for the iframe or In-Page embed implementation. The best practice recommendation is to build a plugin for use with an iframe implementation. The advantages of using the iframe player are:

  • No collisions with existing JavaScript and/or CSS
  • Automatically responsive
  • The iframe eases use in social media apps (or whenever the video will need to "travel" into other apps)

Although integrating the In-Page embed player can be more complex, there are times when you will plan your code around that implementation. To generalize, this approach is best when the containing page needs to communicate to the player. Specifically, here are some examples:

  • Code in the containing page needs to listen for and act on player events
  • The player uses styles from the containing page
  • The iframe will cause app logic to fail, like a redirect from the containing page

Even if your final implementation does not use the iframe code, you can still use the In-Page embed code with a plugin for your JavaScript and a separate file for your CSS. This encapsulates your logic so that you can easily use it in multiple players.

API/Plugin resources used

API Methods API Events API Properties
player.playlist.repeat() loadstart player.mediainfo
on()    

Player/HTML configuration

This section details any special configuration needed during player creation. In addition, other HTML elements that must be added to the page, beyond the in-page embed player implementation code, are described.

Player configuration

Be sure when you create the player the following settings are implemented:

Player Information Settings
Player Information Settings
Playback Settings
Playback Settings

Other HTML

First, the in-page embed player code is nested in TWO HTML div elements. Both of the divs should be removed, and replaced by a div with the class full-bg.

You will also need to modify the attributes of the video-js tag:

  • Add the attribute data-playlist-id="{your playlist id}"
  • Add the attribute id="myPlayerID"
  • Remove the attribute class="video-js"
  • Add the attribute style="object-fit: cover;"
<div class="full-bg">
  <video-js id="myPlayerID"
    data-playlist-id="4450721964001"
    data-account="1752604059001"
    data-player="opeki2sGq"
    data-embed="default"
    data-application-id
    autoplay
    muted
    controls
    style="object-fit: cover;"
  </video>
</div>

Application flow

The basic logic behind this application is:

  • Appropriately style the player and box that contains the overlaid text.
  • Set the playlist to repeat indefinitely.
  • On the load of every video from the playlist display the video title and short description.

Set the playlist to repeat

Find the code which is labeled:

// +++ Set the playlist to repeat +++

The repeat() method from the Playlist API is used to keep the playlist playing indefinitely.

Display the title and description

Find the code which is labeled:

// ### Display the title and description ###

An event handler is used to wait for the loadstart event. This is done as the mediainfo object is not populated until that event is dispatched. Then the name and description are injected into the HTML.

Application styling

The CSS performs the following tasks:

  • Makes the background color of the window black. (for the CodePen only - you don't need to include this)
  • Hides the player controls for the background video player.
  • Disables pointer events on the player.
  • Styles the box that overlays the text. Depending on the size of your player and the amount of content display these styles may need to be adjusted.
  • Styles the player to completely fill the container
  • Styles the h1 used in the overlay text.
  • Styles the div container for the player
  • Styles the vjs-tech component to make the video fully fill the player

Plugin code

Normally when converting the JavaScript into a Brightcove Player plugin nominal changes are needed. One required change is to replace the standard use of the ready() method with the code that defines a plugin.

Here is the very commonly used start to JavaScript code that will work with the player:

videojs.getPlayer('myPlayerID').ready(function() {
  var myPlayer = this;
  ...
});

You will change the first line to use the standard syntax to start a Brightcove Player plugin:

videojs.registerPlugin('pluginName', function(options) {
  var myPlayer = this;
  ...
});

As mentioned earlier, you can see the plugin's JavaScript code in this document's corresponding GitHub repo: full-window-background.js.

Using the plugin with a player

Once you have the plugin's CSS and JavaScript files stored in an Internet accessible location, you can use the plugin with a player. In Studio's PLAYERS module you can choose a player, then in the PLUGINS section add the URLs to the CSS and JavaScript files, and also add the Name and Options, if options are needed.