Product Updates | Contact Support | System Status
Page Contents

    Brightcove Player Sample: Lightbox Carousel

    In this topic, you will learn how to create a lightbox for the Brightcove Player. It uses a jQuery carousel to display a set of videos.

    Player example

    Navigate through the videos in the carousel. Select a thumbnail to play the video in a lightbox container. With the lightbox displayed, select the Close link to hide the lightbox container.

    This example uses the jQuery feature carousel to display the video thumbnails and a Handlebars template to populate the carousel data.

    See the Pen 18201-lightbox-carousel by Brightcove Learning Services (@bcls1969) on CodePen.

    Source code

    View the complete solution on GitHub.

    See the Pen 18201-lightbox-carousel-bcplayer by Brightcove Learning Services (@bcls1969) on CodePen.

    Source code

    View the complete solution on GitHub.


    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 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
    playlist() loadedmetadata

    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

    Add a <div> container to define the feature carousel and the lightbox player with a Close button. The carousel holds a set of video thumbnail images.

    You will need HTML to include the CSS and JavaScript for the Feature Carousel, as well as JavaScript for Handlebars and jQuery.

    Remember to add the id attribute to the video-js tag in the player embed code.

    <video-js id="myPlayerID"

    Application flow

    The basic logic behind this application is:

    • Build the video data array.
    • Build the feature carousel.
    • Play the selected video in the lightbox.
    • Close the lightbox.

    Build video data array

    Find the code which is labeled:

    // +++ Build video data array +++

    Get the playlist data currently loaded in the player, and build an array.

    Build feature carousel

    Find the code which is labeled:

    // +++ Build feature carousel +++

    Use the video data array to build the feature carousel.

    Play selected video

    Find the code which is labeled:

    // +++ Play selected video +++

    When a thumbnail image in the carousel is selected, then load the associated video into the player and start playback. Open the lightbox player with the playing video.

    Close lightbox

    Find the code which is labeled:

    // +++ Close lightbox +++

    When the Close button is selected, stop video playback and hide the lightbox.

    Application styling

    The CSS styles the feature carousel and the lightbox 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: lightbox-scroller.js.

    As mentioned earlier, you can see the plugin's JavaScript code in this document's corresponding GitHub repo: lightbox-scroller.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.

    Page last updated on 19 Jun 2021