Repository files navigation

PlayKit JS IMA plugin integratesIMA SDK for HTML5 with theKaltura Player JS.

PlayKit JS IMA is written inECMAScript6, statically analysed usingFlow and transpiled in ECMAScript5 usingBabel.

The plugin requiresKaltura Player JS to be loaded first.

The plugin uses theIMA SDK for HTML5 Javascript SDK, if the SDK is already loaded on the page the plugin will use it, and if it's not then it will load it.

First, clone and runyarn to install dependencies:

git clone https://github.com/kaltura/playkit-js-ima.gitcd playkit-js-imayarn install

Then, build the player

yarnrunbuild

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

<scripttype="text/javascript"src="/PATH/TO/FILE/kaltura-{ovp/ott}-player.js"></script><!--PlayKit player--><scripttype="text/javascript"src="//imasdk.googleapis.com/js/sdkloader/ima3.js"></script><!--IMA SDK for HTML5--><scripttype="text/javascript"src="/PATH/TO/FILE/playkit-ima.js"></script><!--PlayKit IMA plugin--><divid="player-placeholder"style="height:360px; width:640px"><scripttype="text/javascript">varconfig={provider:{partnerId:{YOUR_PARTNER_ID}...},      ...plugins:{ima:{adTagUrl:'YOUR_AD_TAG_URL'}}...};varplayer=KalturaPlayer.setup(config);player.play();</script></div>

• Configuration & API
• Guides

Tests can be run locally viaKarma, which will run on Chrome, Firefox and Safari

yarn run test

You can test individual browsers:

yarn run test:chromeyarn run test:firefoxyarn run test:safari

We use ESLintrecommended set with some additions for enforcingFlow types and other rules.

SeeESLint config for full configuration.

We also use.editorconfig to maintain consistent coding styles and settings, please make sure you comply with the styling.

TBD

Please readCONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

We useSemVer for versioning. For the versions available, see thetags on this repository.

This project is licensed under the AGPL-3.0 License - see theLICENSE.md file for details