Giter Club home page Giter Club logo

clappr-estat-plugin's Introduction

Clappr eStat streaming Plugin

Mediametrie eStat streaming plugin for Clappr video player.

This plugin use the eStat Javascript streaming tag library.

KNOWN ISSUES:

  • player events are not properly tracked on iOS with Safari if using "native" media controls. (VOD and Live with DVR)
  • Clappr version 0.3.0 or greater not yet supported

Usage

Add both Clappr and the plugin scripts to your HTML:

<head>
  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/clappr@latest/dist/clappr.min.js"></script>
  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/clappr-estat-plugin@latest/dist/clappr-estat-plugin.min.js"></script>
</head>

Then just add ClapprEstatPlugin into the list of core plugins of your player instance, and the options for the plugin go in the estatPlugin property as shown below.

var player = new Clappr.Player({
  source: "http://your.video/here.mp4",
  plugins: {
    core: [ClapprEstatPlugin],
  },
  estatPlugin: {
    eStatTagCfg: {
      serial: 'ESTAT-STREAMING-SERIAL',
      streaming: {
        streamName: 'MyVideoTitle',
        streamGenre: 'MyVideoGenre',
      },
    },
  }
});

eStatTagCfg

eStatTagCfg required property is the eStatTag configuration object. For more details, read eStat streaming manual provided by Mediametrie.

Default plugin behaviour is to automatically update the following eStatTag configuration properties with these values :

  /* eStatTag automatically updated properties */
  {
    measure: '*',            // value is set to 'streaming'
    streaming: {
      diffusion: '*',        // value is set according player playback type ('live', 'replay' or 'timeshifting')
      callbackPosition: '*', // value is the internal player position callback function
      playerName: '*',       // value is set to 'Clappr'
      playerVersion: '*',    // value is set to Clappr player version
      playerObject: '*',     // value is set to player container element
      pluginName: '*',       // value is set to 'clappr-estat-plugin'
      pluginVersion: '*',    // value is set to Clappr eStat streaming plugin version
      streamDuration: '*',   // value is set to video duration (if available, otherwise is not set)
    }
  }

The above configuration properties are not required, but can be overridden in eStatTagCfg plugin option.

Therefore, the minimal required plugin configuration is :

  /* [...] */
  estatPlugin: {
    eStatTagCfg: {
      serial: 'ESTAT-STREAMING-SERIAL',
      streaming: {
        streamName: 'MyVideoTitle',
      },
    },
  }
  /* [...] */

Clappr External Interface

The eStatStreamTag() method is added to Clappr player instance. This method return the eStatTag instance object associated to player.

var player = new Clappr.Player({
  source: "http://your.video/here.mp4",
  plugins: {
    core: [ClapprEstatPlugin],
  },
  estatPlugin: {
    eStatTagCfg: {
      serial: 'ESTAT-STREAMING-SERIAL',
      streaming: {
        streamName: 'MyVideoTitle',
      },
    },
  }
});

var tag = player.eStatStreamTag();

tag.set({
  levels: {
    level_1: 'foo',
    level_2: 'bar',
  }
});

For more details about eStatTag object, read eStat streaming manual provided by Mediametrie.

Load another source without destroy player

Simply use Clappr player configure() method to load another source with new eStat tag configuration :

player.configure({
  source: "http://another.video/here.mp4",
  estatPlugin: {
    eStatTagCfg: {
      serial: 'ESTAT-STREAMING-SERIAL',
      streaming: {
        streamName: 'AnotherVideoTitle',
      },
    },
  }
});

Development

Install dependencies :

  yarn install

Start dev. HTTP server (http://0.0.0.0:8080) :

  yarn start

clappr-estat-plugin's People

Contributors

dependabot[bot] avatar kslimani avatar

Watchers

 avatar  avatar  avatar

clappr-estat-plugin's Issues

eStat tag should be stopped earlier on container change

Currently, on container change, events are rebinds, then process with current container.

With player.configure() use case, plugin should also ensure that any existing tag is stopped before handle new container. (this should fix some issues where tag is not properly stopped if player.configure is called multiple times very fast).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.