@playkit-js/brand3d-overlay NPM

Brand3D Overlay plugin for Kaltura V7

This plugin brings enhanced 3D overlays to Kaltura V7 Player.

Running for development

Clone the repo and run yarn install from a terminal; then run yarn run dev to have the example development page be served on http://localhost:8080, open that address in your browser, you should see a video of drone footage with an overlaid 3D JBL boombox car overlay at the 5 seconds mark.

All code is in src/ folder as follows:

src/
    component.js // the HTML component to be inserted into the player
    constants.js // some constants definitions
    index.html // development page
    index.js // plugin implementation
    style.css // needs work on how to import.

Activate logger

You can activate the included logger by passing the URL query param b3dLog=1. The plugin will become a lot more verbose about its internals.

Release process

As per instructions from Kaltura engineers, last updated Sept 9th, 2021.

It's best to include dist/ folder in the repo.
Run yarn build and wait for the process to finish.
Compress the dist/ folder into a zip file named in semver after the version you're releasing (e.g. v1.1.0.zip).
Move the zip file into releases/ folder.
Commit everything do develop branch.
Create pull request on bitbucket.