Brightcove Player Sample: Live Custom Error Message

Product(s)
Video Cloud
Brightcove Player
Role(s)
Player Developer
Topic(s)
Code Samples
Live Streaming
Overlays
Troubleshooting/Error Handling

In this topic, you will learn how to display a custom overlay image when a user tries to play a live video stream that is not available.

Player example

The player will not be able to connect to the live stream. A ModalDialog object is created, a custom image placed in it, and then the ModalDialog displayed. If the ModalDialog is closed, the default error is shown.

See the Pen 18199-live-custom-error-message 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
addChild() error player.error().code
on() modalclose    
duration()    
player.errorDisplay.hide()    
player.errorDisplay.show()    

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

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

Other HTML

No other HTML elements are added to the page.

Application flow

The basic logic behind this application is:

  • Create an instance of a ModalDialog and place a custom image inside of it.
  • Listen for an error, and if it is the correct error type, display the custom ModalDialog.
  • If the viewer of the video chooses to close the custom ModalDialog, display the default error message.

Create an HTML div element

Find the code which is labeled:

// ### Create a div in which to place HTML content and place image inside ###

You create an HTML div element and place an image in it you wish to display if the live feed is not working.

Build an object in which the HTML div element will be placed

Find the code which is labeled:

// ### Define options object to be used for modal content ###

This is needed when you create the ModalDialog.

Create the ModalDialog and place the image as its content

Find the code which is labeled:

// ### Create Modal with options object ###

This is standard code to create a ModalDialog instance and add it to the player. By default it is NOT displayed.

Listen for an error to be dispatched

Find the code which is labeled:

// ### Listen for an error event ###

When an error is dispatched get the error code and duration.

Check the error type

Find the code which is labeled:

// ### Check if the error code and duration mean no video has loaded ###

To check if a live stream is not playing you first check that the code is 4 (MEDIA_ERR_SRC_NOT_SUPPORTED) and the duration is 0. If that is true, you want to hide the default error that is displayed and show the custom ModalDialog instance.

Display default error is custom ModalDialog is closed

Find the code which is labeled:

// ### If custom modal error closed, show the default error ###

This is done only if you wish to implement this behavior. Simply listen for the modalclose event and in its event handler show the default error.

Application styling

The only CSS simply sizes 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: liveCustomError.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.