README.md

Kaltura Player JS Platform - Cloud TV and OVP Media Players Based on the PlayKit JS Player

The Kaltura Player utilizes a highly modular approach for creating a powerful media player. Each functionality of the player is isolated into separate packages, which are designed to deliver a specific set of abilities. This approach enables extensibility, simplicity and easy maintenance.

The Kaltura Player integrates:

• PlayKit JS - The core library.
• PlayKit JS UI - The UI framework.
• PlayKit JS DASH and PlayKit JS HLS for HLS & MPEG-DASH media source extensions capabilities.
• PlayKit JS IMA for ads and monetization.
• PlayKit JS Providers as the backend media providers.
• PlayKit JS Youbora, PlayKit JS KAVA, and PlayKit JS OTT Analytics as the different analytics plugins.

The Kaltura Player exposes two different players: the Kaltura OVP Player and Kaltura Cloud TV Player. Each player integrates its related packages, as you can see in the following table:

	PlayKit JS	PlayKit JS Providers	PlayKit JS UI	PlayKit JS DASH	PlayKit JS HLS	PlayKit JS Youbora	PlayKit JS OTT Analytics	PlayKit JS KAVA
OVP Player	V	OVP	V	V	V	V		V
Cloud TV Player	V	OTT	V	V	V	V	V	V (*)

* Needs to be configured.

The Kaltura Player is written in ECMAScript6, statically analysed using Flow and transpiled in ECMAScript5 using Babel.

Getting Started

Installing

First, clone and run yarn to install dependencies:

git clone https://github.com/kaltura/kaltura-player-js.git
cd kaltura-player-js
yarn install

Building

Then, build the player

// OVP player
yarn run build:ovp

// Cloud TV player
yarn run build:ott

Next, let's look at how to get started by creating a player using the Player API set.

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 file for details