Skip to content

A plugin for clappr which will get all user events. Event handlers can be used to handle and verify user input, user actions, and browser actions.

License

Notifications You must be signed in to change notification settings

vishalkalola1/Clappr-Analytics-Plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clappr Analytics Plugin

npm version

A plugin for clappr which will get all user events. Event handlers can be used to handle and verify user input, user actions, and browser actions:

  • Things that should be done every time a page loads
  • Things that should be done when the page is closed
  • Action that should be performed when a user clicks a button
  • Content that should be verified when a user inputs data
  • And more ...

Many different methods can be used to let JavaScript work with events:

  • HTML event attributes can execute JavaScript code directly
  • HTML event attributes can call JavaScript functions
  • You can assign your own event handler functions to HTML elements
  • You can prevent events from being sent or being handled
  • And more ...

Usage

Add both Clappr and the Analytics plugin scripts to your HTML:

HTML

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

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

Javascript

var player = new Clappr.Player({
    source: "https://tjenkinson.me/clappr-thumbnails-plugin/assets/video.mp4",
    parentId: "#player",
    plugins: {
        container: [ClapprAnalyticsPlugin]
    },
    analyticsdata: {
        socketbaseurl: 'https://clappranalytics.herokuapp.com/', // add your backend url
        channelname: "events", // get channelname from backend and add here
        offlinedatachannelname: "offlineevents" // get offlineevents from backend and add here
    }
});

Note: Setup Flask with socket.io and connect through websocket. do not use transport long-polling method use websocket

Github Version

Backend

@socketio.on("offlineevents") // "offlineevents" channel name in frontend
def handle_offlinedata(messages):
    return messages
    
@socketio.on("events") // "events" channel name in frontend
def handle_Channel1(message):
    return message

Development Server

npm run start

Development

  • Install dependencies:

npm install

  • Build:

npm run build

  • Minified version:

npm run release

About

A plugin for clappr which will get all user events. Event handlers can be used to handle and verify user input, user actions, and browser actions.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published