@api.video/player-analytics
v2.0.0
Published
api.video player analytics module
Downloads
82
Readme
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
Javascript module to manually call the api.video analytics collector.
This is useful if you are using a video player for which we do not yet provide a ready-to-use monitoring module.
If you use one of the following video player, you should rather use the associated packaged monitoring module:
| Player | monitoring module | | -------- | ------------------------------------------------------------------------------------------- | | video.js | @api.video/api.video-videojs-analytics | | hls.js | @api.video/api.video-hlsjs-analytics |
This module is compatible with React Native.
Getting started
Installation
Method #1: requirejs
If you use requirejs you can add the module as a dependency to your project with
$ npm install --save @api.video/player-analyticsYou can then use the module in your script:
var { PlayerAnalytics } = require('@api.video/player-analytics');
const playerAnalytics = new PlayerAnalytics({
...options // see below for available options
});Method #2: typescript
If you use Typescript you can add the SDK as a dependency to your project with
$ npm install --save @api.video/player-analyticsYou can then use the SDK in your script:
import { PlayerAnalytics } from '@api.video/player-analytics'
const playerAnalytics = new PlayerAnalytics({
...options // see below for available options
});Method #3: imple include in a javascript project
Include the SDK in your HTML file like so:
<head>
...
<script src="https://unpkg.com/@api.video/player-analytics" defer></script>
</head>Then, once the window.onload event has been trigered, instantiate the module with new PlayerAnalytics():
<script type="text/javascript">
var playerAnalytics = new PlayerAnalytics("#target", {
...options // see below for available options
});
</script>Documentation
Instantiation options
The analytics module constructor takes a PlayerAnalyticsOptions parameter that contains the following options:
| Option name | Mandatory | Type | Description |
| ------------------: | --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| mediaUrl | yes | string | url of the media (eg. https://cdn.api.video/vod/vi5oDagRVJBSKHxSiPux5rYD/hls/manifest.m3u8) |
| userMetadata | no | { [name: string]: string }[] | object containing metadata (see Full example below) |
| sequence | no | {start: number; end?: number;} | if only a sequence of the video is going to be played |
| onSessionIdReceived | no | (sessionId: string) => void | callback to be called once the session id is reveiced |
Once the module is instantiated, the following methods have to be called to monitor the playback events.
Module methods
ovbserveMedia(media: HTMLVideoElement)
this method attaches event listeners to the provided HTMLVideoElement to track and analyze media playback events. No data will be collected before this method is called.
dispose()
his method removes all event listeners attached by observeMedia and cleans up any resources used for tracking media playback events.