Skip to content
Kaltura Player JS Platform - Cloud TV and OVP Media Players
JavaScript Other
Branch: master
Clone or download
esakal and OrenMe feat(FEC-8696): allow adding/changing discrete components in U (#264)
add ui components provided by plugins into the configuration object
related PRs:
kaltura/playkit-js#387
kaltura/playkit-js-ui#399
Latest commit 880762e Sep 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: typo in pull request template (#180) Nov 29, 2018
dist chore: update dist Sep 15, 2019
docs docs: add ads link in guides Mar 31, 2019
flow-typed feat(FEC-9023): more logger options (#247) Jun 20, 2019
samples fix(FEC-9103): Remove old kaltura stats (#244) Jun 11, 2019
src feat(FEC-8696): allow adding/changing discrete components in U (#264) Sep 16, 2019
test feat(FEC-9145): support non sibling video tags (#250) Jul 4, 2019
.babelrc feat: register UI events (#109) Apr 11, 2018
.editorconfig 🌅 first commit Jul 30, 2017
.eslintignore feat: ott player (#67) Jan 10, 2018
.eslintrc chore: prettier (#148) Jul 16, 2018
.flowconfig fix: return analytics plugins import (#167) Nov 7, 2018
.gitignore chore: env syncing and fixing (#16) Aug 9, 2017
.prettierignore chore: prettier (#148) Jul 16, 2018
.prettierrc chore: prettier (#148) Jul 16, 2018
.travis.yml chore: Chrome failed on travis - update travis.yml (#269) Sep 16, 2019
CHANGELOG.md chore(release): 0.46.0 Sep 15, 2019
LICENSE Initial commit Jun 13, 2017
README.md fix(FEC-9103): Remove old kaltura stats (#244) Jun 11, 2019
_config.yml Set theme jekyll-theme-cayman Nov 13, 2018
karma.conf.js chore: prettier (#148) Jul 16, 2018
package.json feat(FEC-8696): allow adding/changing discrete components in U (#264) Sep 16, 2019
webpack.config.js fix: add new playkit path alias #157 Oct 7, 2018
webpack.config.ott.js fix(FEC-9103): Remove old kaltura stats (#244) Jun 11, 2019
webpack.config.ovp.js fix(FEC-9103): Remove old kaltura stats (#244) Jun 11, 2019
yarn.lock feat(FEC-8696): allow adding/changing discrete components in U (#264) Sep 16, 2019

README.md

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

Build Status code style: prettier

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:

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

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

You can’t perform that action at this time.