@playkit-js/clip-to-parent NPM

playkit-js-clip-to-parent - ClipsToParent Plugin for the PlayKit JS Player

playkit-js-clip-to-parent plugin allows to watch the original video of a clip. It can be watched in the same page, within the same player, or in a new tab.

playkit-js-clip-to-parent is written in TypeScript, and transpiled in ECMAScript5 using Babel and the TypeScript compiler.

Webpack is used to build the distro bundle and serve the local development environment.

Getting Started

Prerequisites

The plugin requires Kaltura Player to be loaded first.

Installing

First, clone and run yarn to install dependencies:

git clone https://github.com/kaltura/playkit-js-clip-to-parent.git
cd playkit-js-clip-to-parent
yarn install

Building

Then, build the plugin

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

<!--Kaltura player-->
<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Playkit clip to parent plugin -->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-clip-to-parent.js"></script>
<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: {
      clipToParent: {
        openInTab: false
      }
     },
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Configuration

The configuration uses the following structure:

{
  openInTab: boolean
}

config.openInTab
Type: boolean
Default: true
Description: Defines whether the original video will be loaded in a new tab or in the same page, within the same player.