Git Product home page Git Product logo

videojs-player-tracker-reporter's Introduction

videojs-player-tracker-reporter

Tracks events and can display views on the videojs toolbar using your own API.

The plugin will fire a GET on init for a configured getTrackingUrl

Depending of what event is configured see examples, the plugin will fire a PUT request to a configured putTrackingUrl

The params in the config allows you to set request params, in the example below the params will get generate the following URL with the getTrackingUrl set as http://api.myvideservice.com

http://api.myvideoservice.com?videoKey=abcxyz

Table of Contents

Installation

Installation

npm install --save videojs-player-tracker-reporter

Usage

To include videojs-player-tracker-reporter on your website or web application, use any of the following methods.

<script> Tag

This is the simplest case. Get the script in whatever way you prefer and include the plugin after you include video.js, so that the videojs global is available.

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-player-tracker-reporter.min.js"></script>
<script>
  var player = videojs('my-video');

  player.playerTrackerReporter({
        params:{
          videoKey: "abcxyz"
        },
        getTrackingUrl: "tracking api url",
        putTrackingUrl: "tracking api url",
        playerShowTracking: false,
        contentPlayTracking: true,
        videoStartTracking: false,
      });
</script>

Browserify/CommonJS

When using with Browserify, install videojs-player-tracker-reporter via npm and require the plugin as you would any other module.

var videojs = require('video.js');

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-player-tracker-reporter');

var player = videojs('my-video');

player.playerTrackerReporter({
        params:{
          videoKey: "abcxyz"
        },
        getTrackingUrl: "tracking api url",
        putTrackingUrl: "tracking api url",
        playerShowTracking: false,
        contentPlayTracking: true,
        videoStartTracking: false,
      });

RequireJS/AMD

When using with RequireJS (or another AMD library), get the script in whatever way you prefer and require the plugin as you normally would:

require(['video.js', 'videojs-player-tracker-reporter'], function(videojs) {
  var player = videojs('my-video');

  player.playerTrackerReporter({{
        params:{
          videoKey: "abcxyz"
        },
        getTrackingUrl: "tracking api url",
        putTrackingUrl: "tracking api url",
        playerShowTracking: false,
        contentPlayTracking: true,
        videoStartTracking: false,
      });
});

License

MIT. Copyright (c) Tim Bielawski

videojs-player-tracker-reporter's People

Watchers

Tim Bielawski avatar

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.