PlayKit JS Bumper - plugin for the [PlayKit JS Player]


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

[typescript]: https://www.typescriptlang.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io

Getting Started

$3

The plugin requires [Kaltura Player] to be loaded first.

[kaltura player]: https://github.com/kaltura/kaltura-player-js

$3

First, clone and run [yarn] to install dependencies:

[yarn]: https://yarnpkg.com/lang/en/

``
git clone https://github.com/kaltura/playkit-js-bumper.git
cd playkit-js-bumper
yarn install
`

$3

Then, build the player

`javascript
yarn run build
`

$3

Finally, add the bundle as a script tag in your page, and initialize the player

`html







`

Documentation

The bumper plugin purpose is to give the application a way to display a short clip before/after the main entry playback
Allow the player to display a short clip before main entry. (Channel id, Sponsored by and more)

$3


In order to enable the plugin you can give the folowing config parameters while url it the only "must" key to make the plugin work

#### id

default = '' - The bumper container div id

#### url

the url of the bumber video

#### clickThroughUrl

url to a website that will be opened when clicking on the bumper screen

#### position

default [0] - bumper before video playback, it receives an array that configured wheter bumper will be shown on playback start, playback end or both => [0], [-1], [0, -1]

#### disableMediaPreload

default = false, when using main video tag we will want it to be true

#### playOnMainVideoTag

default = false, may be used as true on TV's, ios plays inline = false or ios native full screen mode.

$3

`
plugins: {
bumper: {
id: '',
url: '',
clickThroughUrl: '',
position: [],
disableMediaPreload: false,
playOnMainVideoTag: false
}
}
``

$3

Bumper Plugin Example

$3

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 file for details