playkit-js-unisphere-genie - Genie Plugin for the PlayKit JS Player

playkit-js-unisphere-genie is a kaltura player plugin that loads and initializes the Genie chat runtime inside the player, using the Unisphere Service Plugin for the PlayKit JS Player.

playkit-js-unisphere-genie 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 to be loaded first.

Installing

First, clone and run yarn to install dependencies:

git clone https://github.com/kaltura/playkit-js-unisphere-genie.git
cd playkit-js-unisphere-genie
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

<!--Kaltura player-->
<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Playkit cuepoints plugin -->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-kaltura-cuepoints.js"></script>
<!--PlayKit timeline plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-timeline.js"></script>
<!--Playkit unisphere-service plugin -->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-unisphere-service.js"></script>
<!--Playkit unisphere-genie plugin -->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-unisphere-genie.js"></script>
<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: {
      kalturaCuepoints: {},
      timeline: {},
      unisphereService: {},
      genie: { ... }  // plugin configuration
     },
    };
    var player = KalturaPlayer.setup(config);
    player.loadPlaylist(...);
  </script>
</div>

License

playkit-js-unisphere-genie is released under AGPL-3.0

Dependency

This repo is using the Unisphere Service Plugin for the PlayKit JS Player