Brightcove Player Sample: Creating a Video Loop

Player example

There are some situations where you may want to use a looping video. Keep in mind that a video that loops indefinitely can be distracting to viewers of your website. This example loops the video 3 times and then stops video playback.

See the Pen 18176-Creating a Video Loop by Brightcove Learning Services (@bcls1969) on CodePen.

Source code

View the complete solution on GitHub.

If you plan to only use the In-Page Embed Code implementation and it is ok for the video to loop indefinitely, you can simply add attributes to the video element in your HTML page. For details on how to do this, see the Alternate solution section.

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:

Use the In-Page embed player implementation to test the functionality of your player, plugin and CSS (if CSS is needed)
Put the plugin's JavaScript and CSS into separate files for local testing
Deploy the plugin code and CSS to your server once you have worked out any errors
Use Studio to add the plugin and CSS to your player
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 Step-by-Step: 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
play()	ended

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:

Start video playback when the player loads.
Re-play the video 2 more times and then stop video playback.

Play the video 3 times and stop

Find the code where which is labeled:

  // +++ Loop video 3 times +++

Listen for the player ended event, and then check how many times the video has played. After 3 plays, then do not start video playback again.

Application styling

No additional styling is needed for this sample.

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: video-loop.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.

Alternate solution

If you plan to only use the In-Page Embed Code implementation, you can perform the following two configuration changes to create a loop:

Add the loop attribute to the video-js element in your HTML page.
Use either Studio (Player properties, Playback section) or the Player Management API to set your player to autoplay. Autoplay is a complex issue, and for complete details see the Autoplay Considerations document.

Note that this solution will loop indefinitely.

Here is what your final solution code would look like (remember autoplay set on the player in Studio):

  <!doctype html>
  <html>
  
  <head>
      <meta charset="UTF-8">
      <title>Video Loop</title>
  </head>
  
  <body>
  
    <video-js id="video_1" style="width: 640px; height: 360px;"
         data-video-id="4077874637001"
         data-account="1752604059001"
         data-player="Vkg9W3ZXKe"
         data-embed="default"
         controls
         loop></video-js>
  
      <script src="https://players.brightcove.net/1752604059001/Vkg9W3ZXKe_default/index.min.js"></script>
  
  </body>
  </html>

  <!doctype html>
  <html>
  
  <head>
      <meta charset="UTF-8">
      <title>Video Loop</title>
  </head>
  
  <body>
  
    <video-js id="video_1" style="width: 640px; height: 360px;"
         data-account="1752604059001"
         data-player="Vkg9W3ZXKe"
         data-embed="default"
         controls
         loop></video-js>
  
      <script src="https://players.brightcove.net/1752604059001/Vkg9W3ZXKe_default/index.min.js"></script>
  
  </body>
  </html>

That's it – you are done. You can skip the rest of the steps for this topic.

If you want to limit the number of times the video loops or use the iframe implementation, then use the code discussed in the previous sections of this document.