@playkit-js/playkit-js-ivq
v3.6.0
Published
[![Build Status](https://github.com/kaltura/playkit-js-ivq/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-ivq/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.shields.io/badge
Downloads
721
Readme
PlayKit JS IVQ - Quiz plugin for the [PlayKit JS Player]
PlayKit JS IVQ is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.
Getting Started
Prerequisites
The plugin requires Kaltura Player to be loaded first.
Installing
First, clone and run yarn to install dependencies:
git clone https://github.com/kaltura/playkit-js-ivq.git
cd playkit-js-ivq
yarn install
Building
Then, build the plugin
yarn run build
Testing
The plugin uses cypress
tool for e2e tests
yarn run test
UI conf file (cypress/public/ui-conf.js
) contains Kaltura player and plugin dependencies.
Keep Kaltura player and dependency versinos aligned to currently released versions.
Embed the library in your test page
Finally, add the bundle as a script tag in your page, and initialize the player
<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Kaltura player-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-js-timeline.js"></script>
<!--PlayKit timeline plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-kaltura-cuepoints.js"></script>
<!--PlayKit cuepoints plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-ivq.js"></script>
<!--PlayKit ivq plugin-->
<div id="player-placeholder" style="height:360px; width:640px">
<script type="text/javascript">
var playerContainer = document.querySelector("#player-placeholder");
var config = {
...
targetId: 'player-placeholder',
plugins: {
ivq: { ... },
timeline: { ... },
kalturaCuepoints: { ... },
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia(...);
</script>
</div>
Documentation
IVQ plugin dependencies can been found here:
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details
Dependencies
Plugin dependencies: Cue Points Timeline