Brightcove Player Sample: Age Gate with ModalDialog

Product(s)
Video Cloud
Brightcove Player
Role(s)
Player Developer
Topic(s)
Code Samples
Overlays

In this topic, you will learn how to use a Brightcove player with a simple age gate modal window. The user must certify their age by clicking on the modal window before the video will play.

Player example

This example uses the ModalDialog to initially cover the player. When the user confirms their age by clicking on the modal window, the controls are displayed and the video plays. Test the functionality by clicking anywhere on the modal window.

See the Pen 18193-brightcove-player-sample-age-gate-modaldialog by Brightcove Learning Services (@bcls1969) 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.

Some advantages of using the ModalDialog component include the following:

  • It covers the entire player by default
  • It has methods to easily open and close the modal window

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 ModalDialog API Methods
addChild() ready open()
    on()
    close()

Player/HTML configuration

No special configuration is required for the Brightcove Player you create for this sample.

Application flow

The basic logic behind this application is:

  • Display clickable ModalDialog with text.
  • When the user clicks on the ModalDialog text, close the ModalDialog and start video playback.

Display ModalDialog text

The ModalDialog is displayed as soon as the video is loaded. The age gate text is defined as an option for the ModalDialog.

Configure the ModalDialog

Find the code which is labeled:

// +++ Configure the ModalDialog +++

Create an options object and set properties for the ModalDialog class. For details about this object, see the Implementing the ModalDialog document. Here we do the following:

  • Define the age gate text
  • Set the dialog as temporary so that we can close it
  • Hide the close button on the dialog

Instantiate and open the ModalDialog

Find the code which is labeled:

// +++ Instantiate and open the ModalDialog +++

Instantiate the dialog with our age gate text, add it to the player and open the dialog.

Listen for the click event on the ModalDialog

Find the code which is labeled:

// +++ Listen for the click event on the ModalDialog +++

To the ModalDialog, add an event listener for the click event. When a user selects the age gate text, close the dialog and start video playback.

Application styling

The CSS styles and positions the age gate text within the ModalDialog.

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: age-gate-modal.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.