Menu

Lumen help

Integrating Mesh Delivery with Dash.js

Introduction

Mesh Delivery for Streaming can be integrated into your website with Dash.js, the reference MPEG-DASH player developed and maintained by DASH-IF, in just a few simple steps.

 

We have built an optimized wrapper for Dash.js from v2.6.0.

 

The complete list of integrations we support and guides for setting them up can be found here. If you would like to integrate Mesh Delivery for streaming with a video player not on the list, write to us at cdnsupport@lumen.com and we will help you out.

Not into tutorials?  

Code Example

Step 1: Install Dash.js and Mesh Delivery builds

You will first need to install the builds for Dash.js and the appropriate Mesh Delivery build. This can be done in two ways.

From our CDN

Include these sources in the HTML <head>:

                <!-- Dash.js build -->
<script src="//cdn.dashjs.org/v2.9.2/dash.all.min.js"></script>

<!-- Mesh Delivery wrapper -->
<script src="//cdn.streamroot.io/dashjs-dna-wrapper/1/stable/dashjs-dna-wrapper.js?srKey=YOUR_STREAMROOT_KEY"></script>

To get the highest flexibility of deployment, we recommend setting the StreamrootKey in the Query Parameter "srKey".

 

Parameter name

Mandatory

Description

YOUR_STREAMROOT_KEY

Yes      

The unique Streamroot key that we have assigned to you; make sure it is identical to the one provided in the Account section of your dashboard.

Using npm

Install runtime and dev dependencies:

                npm install @streamroot/dashjs-dna-wrapper

In your application, import/require the package you want to use, like this example:

                import DashDnaWrapper from '@streamroot/dashjs-dna-wrapper';

Step 2: Set up Dash.js and Mesh Delivery

In the HTML <body> or with npm

Parameter name

Mandatory

Description

dnaConfig

No

The object in which you can pass Mesh Delivery options (property, contentIdGenerator, id, etc.).

YOUR_STREAMROOT_KEY

Yes

The unique Streamroot key that we have assigned to you; make sure it is identical to the one provided in the Account section of your dashboard.

YOUR_PLAYLIST_URL

Yes

Your DASH playlist.

Step 3: Visualize Mesh Delivery

To verify that Mesh Delivery was correctly configured, please install our Mesh Delivery graphs.

Vizualization graph for Mesh Delivery

Recommended Options

Mesh Delivery Termination

If you are going to discard or not use the MediaEngine instance anymore, make sure to properly terminate the Mesh Delivery wrapper manually, by calling the destroy() method of the DashJsDnaWrapper class.

                // Reset the player before discarding it
player.reset();

// Destroy the wrapper
wrapper.destroy();

// It is not recommended to use your player after this.

Other Recommendations

 

For optimal performance with live content, we recommend setting the following values in the player options:

                player.updateSettings({
  "streaming": {
    // 30s latency
    "liveDelay": 30s,

    // Or 15 fragments, in the case fragment duration is 2s
    "liveDelayFragmentCount": 15,
  }
}

            
                // 30s latency
player.setLiveDelay(30);

// Or 15 fragments, in the case fragment duration is 2s
player.setLiveDelayFragmentCount(15);

Mesh Delivery currently has compatibility issues when BOLA is activated on live streams; VOD is not affected. We highly recommend deactivating BOLA for live streaming including DVR streams.

For versions 2.6.0 and later, by default dash.js dynamically switches between throughput-based rules and BOLA. Use the following to disable BOLA and use throughput strategy instead (see dash.js documentation).

                player.updateSettings({
  "streaming": {
    "abr": {
      "ABRStrategy": "abrThroughput",
    }
  }
}

            
                mediaPlayer.setABRStrategy("abrThroughput")

And in just a few easy steps you should have a working integration of Mesh Delivery! We encourage you to explore our documentation to understand the various features we offer so you can make the most out of our product.