README

PakhshKit JS IMA - IMA Plugin for the Kontorol Player JS

PakhshKit JS IMA plugin integrates IMA SDK for HTML5 with the Kontorol Player JS.

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

Getting Started

Prerequisites

The plugin requires Kontorol 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://gitlab.com/kontorol/pakhshkit-js-ima.git
cd pakhshkit-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/kontorol-{ovp/ott}-player.js"></script>
<!--PakhshKit 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/pakhshkit-ima.js"></script>
<!--PakhshKit 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 = KontorolPlayer.setup(config);
    player.play();
  </script>
</div>

Documentation

Configuration & API
Guides

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

@pakhshkit-js/pakhshkit-js-ima

Usage no npm install needed!