Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 3.94 KB

README.md

File metadata and controls

107 lines (75 loc) · 3.94 KB
Raw

badge   badge   badge npm ts

api.video videojs analytics plugin

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

Project description

video.js plugin to call the api.video analytics collector.

Getting started

Installation

Method #1: requirejs

If you use requirejs you can add the plugin as a dependency to your project with

$ npm install --save @api.video/videojs-player-analytics

You can then use the plugin in your script:

var videojs = require('video.js');
var { VideoJsApiVideoAnalytics } = require('@api.video/videojs-player-analytics');

videojs.registerPlugin('apiVideoAnalytics', VideoJsApiVideoAnalytics);
const player = videojs('my-video');
player.apiVideoAnalytics();

Method #2: typescript

If you use Typescript you can add the plugin as a dependency to your project with

$ npm install --save @api.video/videojs-player-analytics

You can then use the plugin in your script:

import videojs from 'video.js';
import { VideoJsApiVideoAnalytics } from '@api.video/videojs-player-analytics';

videojs.registerPlugin('apiVideoAnalytics', VideoJsApiVideoAnalytics);
const player = videojs('my-video');
player.apiVideoAnalytics();

Method #3: simple include in a javascript project

Include the plugin in your HTML file like so:

<html>
    <head>
        <link href="https://vjs.zencdn.net/7.10.2/video-js.css" rel="stylesheet" />
        <script src="https://vjs.zencdn.net/7.10.2/video.min.js"></script>
        <script src="https://unpkg.com/@api.video/videojs-player-analytics"></script>
    </head>
    
    <body>
    
        <video id='video-example' class="video-js vjs-default-skin" width="400" height="300" controls>
            <source type="application/x-mpegURL" src="https://cdn.api.video/vod/vi5oDagRVJBSKHxSiPux5rYD/hls/manifest.m3u8">
        </video>
    
        <script>
            videojs.registerPlugin('apiVideoAnalytics', VideoJsApiVideoAnalytics);
            
            var player = videojs('video-example');
            player.apiVideoAnalytics();
        </script>
    </body>
</html>