Brightcove Player Sample: Add Country Flag to Caption Label

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

In this topic, you will learn how to add a country flag in front of the country caption label.

Player example

After you start the video playing, click on the closed captions icon in the controlbar and you will see flags associated with the caption country labels.

See the Pen Add Country Flag to Caption Label 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
on() loadedmetadata
player.controlBar.subsCapsButton.menu.children()

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:

  • Retrieve the captions menu options.
  • Loop over the options, looking for a specific language code.
  • When the language code is found, update the menu option using the corresponding emoji flag in front of the label.

Retrieve the menu options

Find the code which is labeled:

// ### Retrieve the menu options ###

Use the myPlayer.controlBar.subsCapsButton.menu.children() method to retrieve all the options that are displayed in the captions menu. An example of one of the options which contains a language from which to choose appears as follows:

console menu option object

Note that the object contains both the country label and country code. In the JavaScript the country code is searched for as it is possible the country label could be translated by the browser. Some of the menu items are automatically created, and then a menu item for each caption file, which is a text track, is added.

Add flag to each menu option

Find the code which is labeled:

// ### Add flag to each menu option ###

First step is to setup a for-each loop to step over all the menu items. Once the proper menu item is found, the innerHTML is altered, adding the corresponding flag to the country label. In this case, the emoji for the country flag is used. These emojis can be found in numerous places, including EmojiTerra. You can copy the actual emoji, as is done in the supplied code, or if you prefer use the emoji code, for instance 🇩🇪 for the German flag.

Application styling

No CSS 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: country-flag-caption-label.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.