https://github.com/kaltura/playkit-js-kanalytics
Kaltura Analytics plugin for the PlayKit JS Player
https://github.com/kaltura/playkit-js-kanalytics
es6 flow-typed kaltura kaltura-analytics playkit playkit-js
Last synced: 3 months ago
JSON representation
Kaltura Analytics plugin for the PlayKit JS Player
- Host: GitHub
- URL: https://github.com/kaltura/playkit-js-kanalytics
- Owner: kaltura
- License: agpl-3.0
- Created: 2017-06-05T06:23:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-12T02:32:16.000Z (over 2 years ago)
- Last Synced: 2025-06-08T15:07:34.959Z (4 months ago)
- Topics: es6, flow-typed, kaltura, kaltura-analytics, playkit, playkit-js
- Language: JavaScript
- Homepage:
- Size: 1.63 MB
- Stars: 3
- Watchers: 14
- Forks: 2
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PlayKit JS KAnalytics - Kaltura Analytics plugin for the [PlayKit JS Player]
[](https://travis-ci.org/kaltura/playkit-js-kanalytics)
[](https://github.com/prettier/prettier)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-kanalytics)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-kanalytics/v/canary)
PlayKit JS KAnalytics plugin integrates Kaltura analytics with the [PlayKit JS Player].
PlayKit JS KAnalytics is written in [ECMAScript6], statically analysed using [Flow] and transpiled in ECMAScript5 using [Babel].
More info about Kaltura Analytics:
- [Video-Analytics]
- [Creating and tracking analytics KMC]
[video-analytics]: https://corp.kaltura.com/Products/Features/Video-Analytics
[creating and tracking analytics kmc]: https://knowledge.kaltura.com/creating-and-tracking-analytics-kmc-0
[flow]: https://flow.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io
## Getting Started
### Prerequisites
The plugin requires [PlayKit JS Player] to be loaded first.
[playkit js player]: https://github.com/kaltura/playkit-js
### Installing
First, clone and run [yarn] to install dependencies:
[yarn]: https://yarnpkg.com/lang/en/
```
git clone https://github.com/kaltura/playkit-js-kanalytics.git
cd playkit-js-kanalytics
yarn install
```
### Building
Then, build the player
```javascript
yarn run build
```
### Embed the library in your test page
Finally, add the bundle as a script tag in your page, and initialize the player
```html
var playerContainer = document.querySelector("#player-placeholder");
var config = {
...
plugins: {
kanalytics: {
serviceUrl: 'http://stats.kaltura.com/api_v3/index.php'
}
}
...
};
var player = playkit.core.loadPlayer(config);
playerContainer.appendChild(player.getView());
player.play();
```
## Configuration
| Settings | Type | Required | Description |
| ---------- | ------ | ------------------ | -------------------------- |
| serviceUrl | string | :white_check_mark: | The Kaltura API server url |
## Running the tests
Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari
[karma]: https://karma-runner.github.io/1.0/index.html
```
yarn run test
```
You can test individual browsers:
```
yarn run test:chrome
yarn run test:firefox
yarn run test:safari
```
### And coding style tests
We use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.
See [ESLint config](.eslintrc.json) for full configuration.
We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
## Compatibility
TBD
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-kanalytics/tags).
## License
This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details