# Getting Started

Unified Plugin SDK can be easily integrated with any Web app that relies on the following video players:

  • Video.js
  • HLS.js
  • Dash.js
  • HTML5
  • THEOPlayer
  • Shaka
  • Bitmovin
  • Google IMA (Ads)

# Install Unified Plugin

  • With NPM
  • Without NPM

Install the Unified Plugin package:

npm i unified-plugin
1

Import the Unified Plugin:

import UnifiedPlugin from 'unified-plugin';
1

INFO

If you use NPM (or YARN) for server side local testing, you may need to dynamically import the Unified Plugin external library with something like:

// Make sure the window object is available
if (typeof window !== 'undefined') {
  // Dynamically import library
  const UnifiedPlugin = require('unified-plugin');
  // Proceed with UnifiedPlugin instance initialization from "Initialise the Unified Plugin"
  ...
}
1
2
3
4
5
6
7

# Initialise the Unified Plugin

For initializing the Unified Plugin, you only need to pass your account code (from Codavel Panel):

let unifiedPlugin = new UnifiedPlugin('yourAccountCode');
unifiedPlugin.setAnalyticsOptions({'app.name': 'myCustomApp'});
1
2

Initializing the plugin like this will use the default configurations for the Analytics component.

# Next Steps

Now that the Unified Plugin is initialised, you can integrate it in your video player library. Check out our list of integrations here.

Updated: 7/6/2023, 3:26:38 PM