PlayKit JS Dual Screen is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.
The plugin requires Kaltura Player to be loaded first.
First, clone and run yarn to install dependencies:
git clone https://github.com/kaltura/playkit-js-dual-screen.git
cd playkit-js-dual-screen
yarn install
Then, build the player
yarn run build
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-kaltura-cuepoints.js"></script>
<!--PlayKit cuepoint plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-dual-screen.js"></script>
<!--PlayKit dual screen 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: {
dualscreen: { ... },
kalturaCuepoints: { ... },
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia(...);
</script>
</div>
Dual screen plugin configuration can been found here:
Dual screen plugin dependencies can been found here:
If you are showing slides, you MUST also include kalturaCuePoints plugin in the configuration as follow -
plugins: { dualscreen: {...}, kalturaCuepoints: { } }
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.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details
Defines the configuration of the dual screen. Except childSizePercentage
, the configuration only defines the appearance when the player loads. After that, the user can adjust and change it.
//Default configuration
"dualscreen" = {};
//Plugin params
"dualscreen" = {
position?: string, // optional
layout?: string, // optional
childSizePercentage?: number, // optional
slidesPreloadEnabled?: boolean, // optional
childAspectRatio?: { // optional
width: number,
height: number
}
}
Plugin dependencies:
Cue Points