v2.40.0 • For the Javascript Collector

The HLS.js Media Player Extension is a configuration option for the Javascript Collector by Datazoom that makes the following additional data points automatically collectable in real time.

Integration Instructions

Plugin Integration

Datazoom provides plugins for data collection through our Beacon Services. Integrate the hls.js Player plugin into your web application with the following snippet:

<script src='https://platform.datazoom.io/beacon/v1/config?configuration_id=CONFIG_ID'></script>

Insert this JS line into your HTML
Replace the CONFIG_ID value with the collector configuration ID.

This inserts Datazoom's data collection SDK into the page.

Option 1: Activate Data Collection for an Existing hls.js Player Instance

This is the standard option for customers who only need to collect data from the video player and are not concerned with joining player events with CDN logs or sending CMCD data to a CDN.

To activate data collection for an hls.js player instance, create a Datazoom context which references the player instance with the following snippet:

datazoom_context = datazoom.createContext(hlsjs_player);

For example:

<!DOCTYPE html>
<html lang="en">

<head>
    <!-- THE HLS.JS CDN -->
    <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
    <!-- THE DATAZOOM BEACON SCRIPT -->
    <script src='https://platform.datazoom.io/beacon/v1/config?configuration_id=CONFIG_ID'></script>
</head>

<body>

    <div>
        <div style="position:relative;width:640px;height:360px">
            <video id="video" style="position:absolute;top:0;left:0;width:100%;height:100%" controls></video>
        </div>
        <hr />
        <button id="create">Create</button>
    </div>

    <script>
        var hlsjs_player;
        var datazoom_context;

        var media_element = document.getElementById("video");
        var url = "https://devstreaming-cdn.apple.com/videos/streaming/examples/bipbop_16x9/bipbop_16x9_variant.m3u8";

        document.getElementById("create").onclick = function () {
            if (Hls.isSupported()) { // HLS.js is not supported on platforms without MSE enabled
                // Create a player instance
                hlsjs_player = new Hls();
                hlsjs_player.loadSource(url);
                hlsjs_player.attachMedia(media_element);

                // Activates data collection
                datazoom_context = datazoom.createContext(hlsjs_player);
            }
        };
    </script>

</body>

</html>

Option 2: Have Datazoom Create a hls.js Player with Data Collection Activated

This option is necessary if you are joining Player & CDN Log data together or want to send CMCD data to a CDN. In this option, Datazoom will handle instantiation of the player with the necessary hooks required to insert parameters like Content Session ID & Request ID in every media request the player makes.

An hls.js player instance can be created with Datazoom data collection activated, using the following snippet:

datazoom.createContextAndPlayer().then(
    function (context) {
        hlsjs_player = context.getPlayer();
        hlsjs_player.loadSource(url);
        hlsjs_player.attachMedia(media_element);

        datazoom_context = context;
    }
);

By creating a player instance through the datazoom.createContextAndPlayer() method, it enables Datazoom to collect more player information to assist QoE monitoring and distributed tracing.

For example:

<!DOCTYPE html>
<html lang="en">

<head>
    <!-- THE HLS.JS CDN -->
    <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
    <!-- THE DATAZOOM BEACON SCRIPT -->
    <script src='https://platform.datazoom.io/beacon/v1/config?configuration_id=CONFIG_ID'></script>
</head>

<body>

    <div>
        <div style="position:relative;width:640px;height:360px">
            <video id="video" style="position:absolute;top:0;left:0;width:100%;height:100%" controls></video>
        </div>
        <hr />
        <button id="create">Create</button>
    </div>

    <script>
        var hlsjs_player;
        var datazoom_context;

        var media_element = document.getElementById("video");
        var url = "https://devstreaming-cdn.apple.com/videos/streaming/examples/bipbop_16x9/bipbop_16x9_variant.m3u8";


        document.getElementById("create").onclick = function () {
            if (Hls.isSupported()) { // HLS.js is not supported on platforms without MSE enabled
                datazoom.createContextAndPlayer().then(
                    function (context) {
                        hlsjs_player = context.getPlayer();
                        hlsjs_player.loadSource(url);
                        hlsjs_player.attachMedia(media_element);

                        datazoom_context = context;
                    }
                );
            }
        };
    </script>

</body>

</html>

Stop Data Collection

If the data collection must be stopped for any reason, for example after the destruction of the corresponding player instance, invoke the destroy() method of the Datazoom context object as in the following example:

if (hlsjs_player) {
    hlsjs_player.destroy();
    hlsjs_player = null;
}

if (datazoom_context) {
    datazoom_context.destroy();
    datazoom_context = null;
}

NPM (Node Package Manager)

We have made it convenient to manage your HLS.js Collector integration by providing NPM (Node Package Manager) support. Please see installation details here.

References:

hls.js Player API Doc : https://github.com/video-dev/hls.js/blob/master/docs/API.md

CMCD Support

Datazoom provides two discrete settings that control CMCD data collection, one for a specific player event, “Media Object Request”, and one for the corresponding CDN log response.

Player Collector configuration options

Use this option to enable your configured CDN to collect and return CMCD data, contained in the CMCD node of the log line JSON

Off - no CMCD keys are passed
Lite - only the CMCD keys Session ID (sid) and Request ID (rid) are passed to the CDN via query parameter or request header with every “Media Object Request”.
Full - the full set of keys specified by the CMCD standard are passed to the CDN via query parameter or request header with every “Media Object Request”

Bitmovin and JW Player support only the “Lite” setting above

Data Pipe configuration options

Select the CMCD data points you wish to be included in content requests.

Media Object Request - The video player will emit an event called “media_object_request” that will contain the selected CMCD keys below
CMCD keys - Select the CMCD keys you wish to have included with each Media Object Request

Ad Frameworks Extensions

If your Javascript application has a media player with an ad framework, Datazoom’s Javascript Collector with a HLS.js Media Player can be extended with the following ad framework extensions.

Google IMA Ad Framework

MediaTailor Ad Framework

Player Default Ad Framework

Supported Features

CMCD Request Enrichment

Supported Data Points

Events

Discrete occurrences driven by user interactions or system actions

Metadata

Player

CMCD

Attributes

Video

User

Content Session ID

Fluxdata

Metrics measuring changing parameters over time