Playkit JS Offline Manager
PlayKit JS Offline Manager is a javascript library that gives the ability to store and manage content locally. The offline manager provides an API to control the entire download process (download, resume, pause, cancel) and to delete stored content. The offline manager supports storing both clear and protected content.
PlayKit JS Offline Manager is written in ECMAScript6, analyzed statically using Flow, and transpiled in ECMAScript5 using Babel.
Table of Contents
Getting Started
Installing
First, clone and run yarn to install dependencies:
git clone https://github.com/kaltura/playkit-js-offline-manager.git
cd playkit-js-offline-manager
yarn install
Building
Next, build the player:
yarn run buildDocumentation
Refer to this documention for more information:
Running the Tests
Tests can be run locally via Karma, which will run on Chrome, Firefox and Safari browsers.
yarn run test
You can test individual browsers:
yarn run test:chrome
yarn run test:firefox
yarn run test:safari
Coding Style Tests
We use ESLint recommended set with some additions for enforcing Flow types and other rules.
See ESLint config for complete configuration.
We also use .editorconfig to maintain consistent coding styles and settings; please make sure you comply with the styling listed there.
Compatibility
| | IE | Edge| Firefox| Chrome| Safari | Safari IOS| Firefox/Chrome IOS| Chrome for Android| |--|--| --|--|--|--|--|--|--|--|--| | Clear Content Download | +* | +* |+|+|+|+|+|+|| | Protected Content Download | - | - |+|+|+|-|-|+|| |Background fetch download (under development)|-|-|-|-|-|-|-|-|-|-|+|
(+) Tested (+*) Should work, not tested on this platform
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