playkit-js-cpe-tracker

playkit-js-cpe-tracker is a kaltura player plugin that provides information about live stream duration and about the status of requests to kava.

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

Getting started with development

Linter (ESlint)

Run linter:

npm run lint:check

Run linter with auto-fix mode:

npm run lint:fix

Formatting Code

Run prettier to format code

npm run prettier:fix

Type Check

Run type-check to verify TypeScript types

npm run types:check

Automated tests (Mocha/Karma)

Run all tests at once:

npm run test

Configuation Example

plugins: {
  cpeTracker: {
    showSuccessText: false, // determines whether to show text if status is success and the popup is not hovered
    showStatus: true, // determines whether the status part of the popup is visible
    linkUrl: 'https://knowledge.kaltura.com/help/cpe-plugin', // sets the link url for the Need Help link
    alwaysShowProgress: false, // show progress indicator always or on hover
    dependOnAdminTag: "test" // if this value is set, only show the popup if this admin tag appears on the entry
  }
}

Run tests in visual runner

npm run cy:open

License

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details