@playkit-js/hotspots
v3.2.14
Published
[![Build Status](https://github.com/kaltura/playkit-js-hotspots/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-hotspots/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.shield
Downloads
289
Keywords
Readme
PlayKit JS hotspots - plugin for the [PlayKit JS Player]
PlayKit JS hotspots 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-hotspots.git
cd playkit-js-hotspots
yarn install
Building
Then, build the player
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
<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Kaltura player-->
<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-hotspots.js"></script>
<!--PlayKit hotspots 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: {
"playkit-js-hotspots": { ... },
kalturaCuepoints: { ... },
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia(...);
</script>
</div>
Documentation
hotspots plugin configuration can been found here:
hotspots plugin dependencies can been found here:
And coding style tests
We use ESLint recommended set with some additions for enforcing [Flow] types and other rules.
See ESLint config for full configuration.
We also use .editorconfig to maintain consistent coding styles and settings, please make sure you comply with the styling.
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
Commands
Run dev server: yarn dev
;
Bump version: yarn release
;
Configuration
Configuration Structure
//Default configuration
"hotspots" = {};
Dependencies
Plugin dependencies: Cue Points
Dev env
Node version: up to 14+
If nvm installed: nvm use
change version of current terminal to required.
ARM Architecture support
Install dependencies with npm install --target_arch=x64
set target arch for running it through Rosetta (requires Rosetta installation).