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].

[typescript]: https://www.typescriptlang.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io

Getting Started

$3

The plugin requires [Kaltura Player] to be loaded first.

[kaltura player]: https://github.com/kaltura/kaltura-player-js

$3

First, clone and run [yarn] to install dependencies:

[yarn]: https://yarnpkg.com/lang/en/

``
git clone https://github.com/kaltura/playkit-js-hotspots.git
cd playkit-js-hotspots
yarn install
`

$3

Then, build the player

`javascript
yarn run build
`

$3

Finally, add the bundle as a script tag in your page, and initialize the player

`html









`

Documentation

hotspots plugin configuration can been found here:

- Configuration

hotspots plugin dependencies can been found here:

- Dependencies

$3

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

`js
//Default configuration
"hotspots" = {};
`
##




Dependencies

Plugin dependencies:

Cue Points


$3

Node version: up to 14+

If nvm installed: nvm use change version of current terminal to required.


$3

Install dependencies with npm install --target_arch=x64` set target arch for running it through Rosetta (requires Rosetta installation).