Brightcove Player Sample: Toggle Controlbar

Product(s)
Video Cloud
Brightcove Player
Role(s)
Player Developer
Topic(s)
Styling
Code Samples
Type
Support Doc

In this topic, you will learn how to have a button toggle the display of the controlbar.

Player example

Start the video playing, then you will be able to click the Toggle Controlbar button to display or hide the controlbar.

See the Pen Toggle Controlbar 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 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
addClass
toggleClass

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

An HTML button is added to call a function that toggles the controlbar.

Application flow

The basic logic behind this application is:

  • Programmatically add the class to the player.
  • Call the event handler when the button is clicked.
  • Toggle the controlbar by adding or removing the CSS.

Add the class to the player

Find the code which is labeled:

// ### Add the class to the player ###

Use the player's addClass() method to add the CSS class to the player.

Toggle the CSS applied to the controlbar

Find the code which is labeled:

// ### Function called by button that toggles class ###

In the event handler function, use the player's toggleClass() method to add/remove the CSS that displays/hides the controlbar.

Application styling

The first two CSS declarations, and the numerous selectors associated with them, are needed to specify the changes to the classes that define the transforms. The second two declarations disable the controlbar rise/fall on mouseEnter and mouseLeave events. If you were to remove the second two declarations, even when the controlbar is hidden, a mouse enter would make it appear.

Plugin code

Since the button needs to call a function outside the player's scope, it does not make sense to create a plugin for this functionality.