@playkit-js/skip
v1.4.5
Published
[![Build Status](https://github.com/kaltura/playkit-js-skip/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-skip/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.shields.io/bad
Downloads
52
Readme
PlayKit JS Skip - [Skip] UI Plugin for the Kaltura Player JS
PlayKit JS Skip is written in ECMAScript6, statically analysed using Flow and transpiled in ECMAScript5 using Babel.
Getting Started
Prerequisites
The plugin requires Kaltura Player JS to be loaded first.
Installing
First, clone and run yarn to install dependencies:
git clone https://github.com/kaltura/playkit-js-skip.git
cd playkit-js-skip
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
Note: The config can be supplied in two ways:
- Globally - In the Plugin level (and will apply globally for all entries) or
- Specifiably In the Media / Entry level:
<script type="text/javascript" src="/PATH/TO/FILE/kaltura-ovp-player.js"></script>
<script type="text/javascript" src="/PATH/TO/FILE/playkit-skip.js"></script>
<div id="player-placeholder"" style="height:360px; width:640px">
<script type="text/javascript">
const config = {
targetId: 'player-placeholder',
provider: {
partnerId: {YOUR_PARTNER_ID}
...
},
plugins: {
skip: {
timeout: 6
}
}
// translations - for local environment
// ui: {
// translations: {
// en: {
// "skip": {
// "skipIntro": "Skip Intro",
// "watchNext": "Watch Next"
// }
// }
// }
// }
};
// 1. Config - in the media level - (needed just in case it is not returned from the KMC)
// const kalturaPlayer = KalturaPlayer.setup(config);
// kalturaPlayer.loadMedia({entryId: '0_wifqaipd'}, {
// metadata: {
// intro: {
// startTime: 1,
// endTime: 32,
// },
// outro: {
// startTime: 4,
// endTime: 5,
// }
// }
// });
// 2. Config - in the Plugin level - (global for all entries)
const kalturaPlayer = KalturaPlayer.setup({
...config,
plugins: {
skip: {
timeout: 4,
intro: {
relativeTime: 10
},
outro: {
relativeTime: 5
}
}
}
});
kalturaPlayer.loadMedia({entryId: '0_wifqaipd'});
</script>
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.
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