API Reference

Shaka Player (Web)

Integrate Gumlet insights with Shaka player and monitor video playback performance.

Shaka Player is a popular player to play videos on the web.

Step 1: Gumlet SDK Installation

The best and easiest way to install gumlet-insights.min.js is by including it in head section of the pages after the Shaka Player has been included in the page.

<!-- Include other shaka player files here -->
<script src="/path/to/shaka-player.js"></script>

<!-- Include gumlet insights sdk after Shaka-Player.js -->
<script src="https://cdn.gumlytics.com/insights/1.1/gumlet-insights.min.js"></script>

Step 2: Initialise the player

Initialise the Shaka player with the appropriate player options and the video URL to be played.

<script type="text/javascript">
	
  	let manifestUri = 'https://video.gumlet.io/5f462c1561cf8a766464ffc4/61dd877c6ec832ab2aaa1837/7.mpd'

    function initApp() {
      // Install built-in polyfills to patch browser incompatibilities.
      shaka.polyfill.installAll();

      // Check to see if the browser supports the basic APIs Shaka needs.
      if (shaka.Player.isBrowserSupported()) {
        // Everything looks good!
        initPlayer();
      } else {
        // This browser does not have the minimum set of APIs we need.
        console.error('Browser not supported!');
      }
    }

    function initPlayer() {

      var startTime = new Date().getTime();

      // Create a Player instance.
      var video = document.getElementById('my-video');
      var player = new shaka.Player(video);

      // Attach player to the window to make it easy to access in the JS console.
      window.player = player;

      // Listen for error events.
      player.addEventListener('error', onErrorEvent);

      // Try to load a manifest.
      // This is an asynchronous process.
      player.load(manifestUri).then(function() {
        // This runs if the asynchronous load is successful.
        console.log('The video has now been loaded!');
      	// onError is executed if the asynchronous load fails.
      }).catch(onError);
    }

    function onErrorEvent(event) {
      // Extract the shaka.util.Error object from the event.
      onError(event.detail);
    }

    function onError(error) {
      // Log the error.
      console.error('Error code', error.code, 'object', error);
    }

    document.addEventListener('DOMContentLoaded', initApp);

</script>

Step 3: Create Gumlet Configuration JSON

All the data is associated to a property ID which you need to get from our dashboard. Pass it in the config JSON as property_id. This is the only required field.

There is an option to pass extra data such as the user specific data and video meta data which can be viewed in the dashboard as data breakdowns. A full list of variables is available here.

<script type="text/javascript">

  // Create the Gumlet Configuration JSON
  var gumletConfig = {
    property_id: 'PROPERTY_ID_GOES_HERE', // required:  please replace with correct property id.
  };

</script>

Step 4: Initialise Gumlet SDK

Initialise the Gumlet Insights SDK with the config JSON to start receiving data on your dashboard. You will then have to attach the player object in the initPlayer function which we created on step 2.

<script type="text/javascript">

	var analytics = gumlet.insights(config);
	
  function initPlayer() {
    ...
    var player = new shaka.Player(video);
    analytics.registerShakaPlayer(player, {mediaElement: video});
    window.player = player;
    ...
  }

</script>

🚧

Pass the video object as mediaElement

Please be sure to pass the mediaElement to the registerShakaPlayer as well.

👍

Done!

Once you integrate with these steps, you should start seeing data on your customised dashboard.

Full Code Example

<!DOCTYPE html>
<html lang="en" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>Gumlet Insights SDK</title>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/shaka-player/4.1.2/shaka-player.compiled.js"></script>
    <script type="text/javascript" src="https://cdn.gumlytics.com/insights/1.1/gumlet-insights.min.js"></script>
  </head>
  <body>
    <h1>Gumlet Insights SDK</h1>
    <div id="player" style="width: 400px">
    	<video id="my-video" preload="true" width="640" height="264" controls></video>
    </div>
    <script type="text/javascript">

      var config = {
        property_id: 'TEST_PROPERTY', // required:  please replace with correct property id.
      };

    	var analytics = gumlet.insights(config);

    	let manifestUri = 'https://video.gumlet.io/5f462c1561cf8a766464ffc4/61dd877c6ec832ab2aaa1837/7.mpd'

      function initApp() {
        // Install built-in polyfills to patch browser incompatibilities.
        shaka.polyfill.installAll();

        // Check to see if the browser supports the basic APIs Shaka needs.
        if (shaka.Player.isBrowserSupported()) {
          // Everything looks good!
          initPlayer();
        } else {
          // This browser does not have the minimum set of APIs we need.
          console.error('Browser not supported!');
        }
      }

      function initPlayer() {

        var startTime = new Date().getTime();

        // Create a Player instance.
        var video = document.getElementById('my-video');
        var player = new shaka.Player(video);

        analytics.registerShakaPlayer(player, {mediaElement: video});

        // Attach player to the window to make it easy to access in the JS console.
        window.player = player;

        // Listen for error events.
        player.addEventListener('error', onErrorEvent);

        // Try to load a manifest.
        // This is an asynchronous process.
        player.load(manifestUri).then(function() {
          // This runs if the asynchronous load is successful.
          console.log('The video has now been loaded!');
        // onError is executed if the asynchronous load fails.
        }).catch(onError);
      }

      function onErrorEvent(event) {
        // Extract the shaka.util.Error object from the event.
        onError(event.detail);
      }

      function onError(error) {
        // Log the error.
        console.error('Error code', error.code, 'object', error);
      }

    	document.addEventListener('DOMContentLoaded', initApp);

  </script>
  </body>
</html>

How to?

Add custom data

You can send first party user data to our dashboard via the SDK. While building the configuration to initialise the SDK object you can pass these parameters. 

var gumletConfig = {
		property_id : 'PROPERTY_ID_GOES_HERE', // required:  please replace with correct property id.
		userId : '123',
		userName : 'Océane Bourgeois',
		userEMail : '[email protected]',
		userPhone  : '(840)-295-4133',
		userProfileImage : 'https://assets.gumlet.io/assets/gumlet-logo-white-font.png?w=240&format=auto',
		userAddressLine1 : '8774, Rue de la Mairie',
		userAddressLine2 : '',
		userCity : 'Reims',
		userState : 'Landes',
		userCountry : 'France',
		userZipcode : '83894',
		customContentType : 'episode',
		customVideoDurationMillis : 2600000, // 43 minutes 20 seconds
		customEncodingVariant : 'test1',
		customVideoLanguage : 'English',
		customVideoId : 'HIMYMSeason1Episode1',
		customVideoSeries : 'HIMYMSeason1',
		customVideoProducer : 'Ece Tekelioglu',
		customVideoTitle : 'Pilot',
		customVideoVariantName : '',
		customVideoVariant : '',
		customPlayerIntegrationVersion : 'v1.1',
		customPlayerName : 'Trailer',
		customPageType : 'Homepage',
		customData1 : '',
		customData2 : '',
		customData3 : '',
		customData4 : '',
		customData5 : '',
		customData6 : '',
		customData7 : '',
		customData8 : '',
		customData9 : '',
		customData10 : ''
 };

 var gumletInsights = gumlet.insights(gumletConfig);

Change the essential user details being sent to the Gumlet Dashboard.

If the user decides to login after the Gumlet SDK was attached to the player then you can use the following function to update the data being sent to the Gumlet backend.

Use the updateCustomUserData() function available in the SDK.

gumletInsights.updateCustomUserData({
		userId            : '123',
		userName          : 'Christelle Robert',
		userEMail         : '[email protected]',
});

Change the video title that is being played in the player.

If your app supports multiple videos in the same player after it is initialised then you need to tell our SDK to track the new video details after the player finishes playing a video and is about to start the new video.

Use the updateCustomVideoData() function available in the SDK

gumletInsights.updateCustomVideoData({
	  customVideoTitle : 'Episode2'
})

API Documentation

insights(config)

The Initialise method takes in a config JSON and returns a Gumlet Insights object which is then attached with a player. Only the property id to which data is to be sent is a mandatory parameter, but there is an option to pass custom data as well, the whole list of parameters is available here

// Create the Gumlet Configuration JSON
var gumletConfig = {
		property_id: 'PROPERTY_ID_GOES_HERE', // required:  please replace with correct property id.
};

var gumletInsights = gumlet.insights(gumletConfig);

registerShakaPlayer(player, {mediaElement: videoTag})

The register method takes in a Shaka player object as an argument. After the SDK has been installed and initialised on the page it needs a player object to listen events from. The register event accepts this player object and attaches the Gumlet Insight object with the player.

If there are multiple player windows on a page please initialise the same number of Gumlet SDK objects and pass the different player objects to it.

❗️

Gumlet insights SDK won't start sending data to the dashboard unless the player is registered with it.

analytics.registerShakaPlayer(playerObject, {mediaElement: videoTagObject});

updateCustomUserData(data)

Gumlet Insights SDK allows you to pass user data which is stored in the projects main database to allow analysis at user level complete list of user parameters is available here

There is an option to update this data via a function call while the SDK is already initialised with some user data.

gumletInsights.updateCustomUserData({
		userId            : '123',
		userName          : 'Christelle Robert',
		userEMail         : '[email protected]',
		userPhone         : '(078)-380-95-96',
		userProfileImage  : 'https://assets.gumlet.io/assets/gumlet-logo-white-font.png?w=240&format=auto',
		userAddressLine1  : '8774, Rue de la Mairie',
		userAddressLine2  : '',
		userCity          : 'Reims',
		userState         : 'Landes',
		userCountry       : 'France',
		userZipcode       : '83894',
  });

updateCustomVideoData(data)

Gumlet Insights SDK allows you to pass custom data related to a video to easily identify and drill down metrics for a particular video on the dashboard. A complete list of parameters is available here

gumletInsights.updateCustomVideoData({
		customContentType             : 'episode',
		customVideoDurationMillis     : 2405000, // 40 minutes 5 seconds
		customEncodingVariant         : 'test1',
		customVideoLanguage           : 'English',
		customVideoId                 : 'HIMYMSeason1Episode2',
		customVideoSeries             : 'HIMYMSeason1',
		customVideoProducer           : 'Ece Tekelioglu',
		customVideoTitle              : 'Episode2',
		customVideoVariantName        : '',
		customVideoVariant            : '',
})

updateCustomData(data)

Each SDK allows ten additional data points which can be used to a particular use case for an application. The values in these parameters can be anything which needs to be tracked. Each parameter is optional ad accepts alphanumeric values. The whole lit of parameters is available here

gumletInsights.updateCustomData({
		customData1   : '',
		customData2   : '',
		customData3   : '',
		customData4   : '',
		customData5   : '',
		customData6   : '',
		customData7   : '',
		customData8   : '',
		customData9   : '',
		customData10  : ''
});