@api.video/hlsjs-player-analytics
Advanced tools
Readme
hls.js module to call the api.video analytics collector.
First include https://unpkg.com/@api.video/hlsjs-player-analytics in your web page.
<script src="https://unpkg.com/@api.video/hlsjs-player-analytics"></script>
Then, before having instanciated Hls, instanciate a HlsJsApiVideoAnalytics object.
The HlsJsApiVideoAnalytics constructor take the following parameters:
| Parameter name | Mandatory | Type | Description |
|---|---|---|---|
| hls | yes | Hls instance | the instance of Hls |
| options | no | HlsJsApiVideoAnalyticsOptions (see below) | optional options |
Available options (HlsJsApiVideoAnalyticsOptions):
| Option name | Mandatory | Type | Description |
|---|---|---|---|
| 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 |
var hls = new Hls();
new VideoElementApiVideoAnalytics(hls, {
sequence: {
start: 10,
end: 50
},
userMetadata: {
gender: "male"
}
});
Include the module in your HTML file like so:
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
<script src="https://unpkg.com/@api.video/hlsjs-player-analytics"></script>
</head>
<body>
<video id="video" controls width=640 height=480></video>
<script>
var video = document.getElementById('video');
var videoSrc = 'https://cdn.api.video/vod/vi5oDagRVJBSKHxSiPux5rYD/hls/manifest.m3u8';
if (Hls.isSupported()) {
var hls = new Hls();
new VideoElementApiVideoAnalytics(hls);
hls.loadSource(videoSrc);
hls.attachMedia(video);
}
</script>
</body>
</html>
FAQs
api.video player analytics plugin for hls.js based players
The npm package @api.video/hlsjs-player-analytics receives a total of 39 weekly downloads. As such, @api.video/hlsjs-player-analytics popularity was classified as not popular.
We found that @api.video/hlsjs-player-analytics demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The White House is addressing fragmented cybersecurity regulations as CISOs report spending up to 50% of their time on compliance, aiming to harmonize requirements and improve cybersecurity outcomes.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.
Security News
NIST updates on the NVD backlog after media reports that over 50% of KEVs were unenriched since mid-February. They've contracted additional support and partnered with CISA to clear the backlog by fiscal year-end.