playkit-js-detect-ad-block - Ad Block Detection Plugin for the PlayKit JS Player

playkit-js-detect-ad-block is written in TypeScript (*.ts), and transpiled in ECMAScript5 using Babel and the TypeScript compiler.

Webpack is used to build the distro bundle and serve the local development environment.

Getting Started

Prerequisites

The plugin requires Kaltura Player and playkit-ui-managers to be loaded first.

Installing

First, clone and run yarn to install dependencies:

git clone https://github.com/kaltura/playkit-js-detect-ad-block.git
cd playkit-js-detect-ad-block
yarn install

Building

Then, build the plugin

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-ui-managers.js"></script>
<!--Playkit ui managers plugin -->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-detect-ad-block.js"></script>
<!--Playkit detect ad block 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: {
       uiManagers: {},
       detectAdBlock: {
        testUrl: "", // url to test against
        hideMessageOnClick: true, // whether to allow hiding overlay while ad block is still active,
        messageTitle: "", // overlay title
        messageDescription: "", // overlay description
        primaryButtonLabel: "", // primary button text
        secondaryButtonLabel: "" // secondary button text
       }
     },
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

License

playkit-js-detect-ad-block is released under AGPL-3.0