https://github.com/kaltura/playkit-js-kava
Kaltura Advanced Video Analytics Plugin for the Kaltura Player
https://github.com/kaltura/playkit-js-kava
analytics es6 flow-typed playkit-js video
Last synced: 4 months ago
JSON representation
Kaltura Advanced Video Analytics Plugin for the Kaltura Player
- Host: GitHub
- URL: https://github.com/kaltura/playkit-js-kava
- Owner: kaltura
- License: agpl-3.0
- Created: 2018-02-04T09:32:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-06-27T06:11:33.000Z (4 months ago)
- Last Synced: 2025-06-27T06:14:16.088Z (4 months ago)
- Topics: analytics, es6, flow-typed, playkit-js, video
- Language: TypeScript
- Homepage:
- Size: 1.43 MB
- Stars: 3
- Watchers: 16
- Forks: 1
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PlayKit JS Kava - Kaltura Advanced Video Analytics Plugin for the [Kaltura Player JS]
[](https://github.com/kaltura/playkit-js-kava/actions/workflows/run_canary_full_flow.yaml)
[](https://github.com/prettier/prettier)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-kava)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-kava/v/canary)
PlayKit JS Kava plugin integrates Kava (Kaltura Advanced Video Analytics) with the [Kaltura Player JS].
The main purpose of this plugin is to track and collect various events and data about the video player.
PlayKit JS Kava is written in [ECMAScript6], statically analysed using [Flow] and transpiled in ECMAScript5 using [Babel].
[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.
[kaltura player js]: https://github.com/kaltura/kaltura-player-js
### Installing
First, clone and run [yarn] to install dependencies:
[yarn]: https://yarnpkg.com/lang/en/
```
git clone https://github.com/kaltura/playkit-js-kava.git
cd playkit-js-kava
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 config = {
targetId: 'player-placeholder',
provider: {
partnerId: {PARTNER_ID}
...
},
plugins: {
kava: {
...
}
...
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia({
entryId: '{ENTRY_ID}'
...
});
```
## Documentation
### Table of Contents
- [Configuration & API](docs/configuration-api.md)
- [Events](./docs/kava-events.md)
- [Parameters](./docs/kava-parameters.md)
## 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