About

Moderation plugin provides applications ability to add reporting mechanisem for the content that being played in case users find it not appropriate.

PlayKit JS Moderation is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.

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-moderation.git cd playkit-js-moderation yarn install

Building

Then, build the player

yarn run build

Embed the library on your test page

Finally, add the bundle as a script tag on 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-moderation.js"></script>
<!--PlayKit moderation 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: {       playkit-js-moderation: { ... }     }     ...    };    var player = KalturaPlayer.setup(config);    player.loadMedia(...);  </script>
</div>

Documentation

Moderation plugin configuration can been found here:

• Configuration

And coding style tests

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.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

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

Configuration

Configuration Structure

//Plugin params
"playkit-js-moderation": {  reportLength?: number, // optional  onReportSentMessage?: string, // optional  onReportErrorMessage?: string, // optional  subtitle?: string, // optional extra information to be displayed  tooltipMessage?: string, // optional  notificatonDuration?: number, // miliseconds, optional  moderateOptions?: Array< {id: number, label: string} > // optional
}

Plugin Default configuration

"playkit-js-moderation" = {};

"playkit-js-moderation": {    "reportLength": 500,    "onReportSentMessage": "The report sent",    "onReportErrorMessage": "The report failed to send",    "subtitle": "",    "notificatonDuration": 5000,    "tooltipMessage": "Send report",    "moderateOptions": [      {              "id": 1,              "label": "Sexual Content"      },      {              "id": 2,              "label": "Violent Or Repulsive"      },      {              "id": 3,               "label": 'Harmful Or Dangerous Act"      },      {              "id": 4,              "label": "Spam / Commercials"      },      {            "id": 5,            "label": "Copyright Violation"      },      {              "id": 6,              "label": "Terms of Use Violation"      }    ]  }

Example:

Docs:

config.reportLength

Type: number

Default: 500

config.onReportSentMessage

Type: string

Default: The report sent

config.onReportErrorMessage

Type: string

Default: The report failed to send

config.subtitle

Type: string

Default: -

config.tooltipMessage

Type: string

Default: Send report

config.notificatonDuration

Type: number

Default: 5000

config.moderateOptions

Type: Array< {id: number, label: string} >

Default:

moderateOptions = [  {id: 1, label: 'Sexual Content'},        {id: 2, label: 'Violent Or Repulsive'},        {id: 3, label: 'Harmful Or Dangerous Act'},        {id: 4, label: 'Spam / Commercials'}
]