@playkit-js/prevent-forward-seeks
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

Build Status

playkit-js-prevent-forward-seeks

playkit-js-prevent-forward-seeks is a [kaltura player] plugin that prevent forward/ all seeks in these cases: if isActive is true and Metadata Exists => let the metadata decide if this feature is on; else take value from isActive

The default is to prevent forward seeks if the feature is ON. To disable all seeks turn this flat into true:

disableAllSeeks: true;

Features

This plugin prevents forward seek in these cases: if isActive is true and Metadata Exists => let the metadata decide if this feature is on; else take value from isActive

Getting started with development

# First, checkout the repository and install the required dependencies
git clone https://github.com/kaltura/playkit-js-prevent-forward-seeks.git

# Navigate to the repo dir
cd playkit-js-prevent-forward-seeks

# Run dev-server for demo page (recompiles on file-watch, and write to actual dist fs artifacts)
npm run dev

# Before submitting a PR - Run the pre commit command
npm run pre:commit

# this command will run:

# 1. types check
# 2. lint check
# 3. generate/update types
# 4. generate/update docs

The dev server will host files on port 800x. Once started, the demo can be found running at http://localhost:800x/.

Before submitting a PR, please see our contribution guidelines.

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 test

Run unit tests in watch mode:

npm run test:watch

How to config

ui: {
  translations: {
    en: {
      'plugin-prevent-forward-seeks': {}
    }
  }
},
plugins: {
  pluginPreventForwardSeeks: {
    metaDataFieldName: 'BanSeek',
    isActive: true,
    showSeekModal: true,
    disableAllSeeks: true // optional (default false)
  }
}

Package Sidebar

Install

npm i @playkit-js/prevent-forward-seeks

Weekly Downloads

1

Version

1.0.4

License

Apache-2.0

Unpacked Size

1.13 MB

Total Files

7

Last publish

Collaborators

  • orenme
  • adi-mach-kaltura
  • shai.kaltura
  • eransakalkaltura
  • semarche
  • playkitjs.bot