PlayKit JS Playlist - plugin for the [PlayKit JS Player]

PlayKit JS Playlist 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-playlist.git
cd playkit-js-playlist
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-playlist.js"></script>
<!--PlayKit playlist 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: {
       playlist: {
       }
     }
     ...
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Configuration

Configuration Structure

//Default configuration
"playlist" = {};
//Plugin params
"playlist" = {
  expandOnFirstPlay?: boolean, // optional
  position?: string, // optional
  expandMode?: string, // optional
  playNextOnError?: boolean // optional
}

config.expandOnFirstPlay

Type: boolean

Default: true

Description: if plugin should automatically open on first play.

config.position

Type: 'right' | 'left' | 'top' | 'bottom'

Default: right

Description: expand mode of side panel (‘alongside', ‘hidden’, 'over’, default 'alongside').

config.expandMode

Type: string

Default: alongside

Description: expand mode of side panel (‘alongside', ‘hidden’, 'over’, default 'alongside').

config.playNextOnError

Type: boolean

Default: true

Description: If entry playback fails the playlist will move playback to the next entry.

Running the tests

The plugin uses cypress tool for e2e tests

yarn run test

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