PlayKit JS Kaltura-live - plugin for the [PlayKit JS Player]

PlayKit JS Kaltura-live is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.

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-kaltura-live.git
cd playkit-js-kaltura-live
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-player.js"></script>
<!--Kaltura player-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-kaltura-live.js"></script>
<!--PlayKit Kaltura-live 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: {
      "kaltura-live": { ... },
     }
     ...
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Documentation

Kaltura-live plugin configuration can been found here:

• Configuration

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

Commands

Run dev server: yarn dev; Bump version: yarn release;

Configuration

Configuration Structure

//Default configuration
"kaltura-live" = {};
//Plugin params
"kaltura-live" = {
    checkLiveWithKs: boolean,
    isLiveInterval: number,
    bufferingFailoverTimeout: number,
    preOfflineSlateUrl: string, 
    postOfflineSlateUrl: string,
    preOfflineEntryId: string, 
    postOfflineEntryId: string,
    offlineSlateWithoutText: boolean,
    showLiveViewers: boolean
}

Player allows customisation of pre and post live broadcast slates per uiconf.

By default the player will use the live-entry thumbnail as the background to the “brodcast not started” and “broadcast ended” slates. Nevertheless, it allows customising the experience by providing a url to an alternative background image for each of the slates.

//Plugin params to configure slates background image
"kaltura-live" = {
    preOfflineSlateUrl: string, 
    postOfflineSlateUrl: string
}

Kaltura entries can be used as background of pre and post broadcast slates (media plays in loop). Note that pre/postOfflineEntryId has more priority than pre/postOfflineSlateUrl properties if both provided.

//Plugin params to configure slates background image
"kaltura-live" = {
    preOfflineEntryId: string, 
    postOfflineEntryId: string
}

One can also choose to hide the text message on the slate.

//Plugin param to hide text messages on the pre and post slates
"kaltura-live" = {
    offlineSlateWithoutText: boolean
}

config.checkLiveWithKs

Type: boolean

Default: false

config.isLiveInterval

Type: number

Default: 10

config.bufferingFailoverTimeout

Type: number

Default: 10

config.preOfflineSlateUrl

Type: string

Default: undefined

config.postOfflineSlateUrl

Type: string

Default: undefined

config.preOfflineEntryId

Type: string

Default: undefined

config.postOfflineEntryId

Type: string

Default: undefined

config.offlineSlateWithoutText

Type: boolean

Default: false

config.showLiveViewers

Type: boolean

Default: false