Skip to content
IMA Plugin for the Kaltura Player JS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github docs: added readme and issue and pull request templates (#4) Aug 13, 2017
docs feat(FEC-9074): expose the vastLoadTimeout value (#108) May 19, 2019
flow-typed feat(FEC-9074): expose the vastLoadTimeout value (#108) May 19, 2019
samples fix: re-design companions config (#34) Dec 11, 2017
scripts build: refactor build process (#68) Aug 22, 2018
src feat(FEC-9145): support non sibling video tags (#121) Jul 4, 2019
test feat(FEC-8631): bumper plugin (#96) Jun 13, 2019
.babelrc 1st version Jul 3, 2017
.editorconfig fixes and logs Jul 6, 2017
.eslintignore init demo Jun 12, 2017
.eslintrc.json chore: prettier (#63) Jul 16, 2018
.flowconfig fix(FEC-8517): don't preload ad on reset (#70) Sep 5, 2018
.gitignore build: refactor build process (#68) Aug 22, 2018
.npmignore chore: include flow-typed Aug 22, 2018
.prettierignore chore: prettier (#63) Jul 16, 2018
.prettierrc
.travis.yml build: refactor build process (#68) Aug 22, 2018
CHANGELOG.md chore(release): 0.14.0 Jul 7, 2019
LICENSE Initial commit Mar 16, 2017
README.md chore: fix NPM badges Jan 28, 2019
_config.yml Set theme jekyll-theme-cayman Nov 5, 2018
karma.conf.js feat(FEC-8631): bumper plugin (#96) Jun 13, 2019
package.json chore(release): 0.14.0 Jul 7, 2019
webpack.config.js fix(FEC-9051): Added umdNameDefine true to support requireJS in IMA Apr 24, 2019
yarn.lock

README.md

PlayKit JS IMA - IMA Plugin for the Kaltura Player JS

Build Status code style: prettier

PlayKit JS IMA plugin integrates IMA SDK for HTML5 with the Kaltura Player JS.

PlayKit JS IMA is written in ECMAScript6, statically analysed using Flow and transpiled in ECMAScript5 using Babel.

Getting Started

Prerequisites

The plugin requires Kaltura Player JS to be loaded first.

The plugin uses the IMA 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.

Installing

First, clone and run yarn to install dependencies:

git clone https://github.com/kaltura/playkit-js-ima.git
cd playkit-js-ima
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-{ovp/ott}-player.js"></script>                     <!--PlayKit player-->
<script type="text/javascript" src="//imasdk.googleapis.com/js/sdkloader/ima3.js"></script> <!--IMA SDK for HTML5-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-ima.js"></script>                 <!--PlayKit IMA plugin-->
<div id="player-placeholder" style="height:360px; width:640px">
<script type="text/javascript">
var config = {
  provider: {
    partnerId: {YOUR_PARTNER_ID}
    ...
  },
  ...
  plugins: {
    ima: {
      adTagUrl: 'YOUR_AD_TAG_URL'
    }
  }
  ...
};
var player = KalturaPlayer.setup(config);
player.play();
</script>

Documentation

Running the tests

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

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

Compatibility

TBD

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


You can’t perform that action at this time.