[](https://github.com/kaltura/playkit-js-image-player/actions/workflows/run_canary_full_flow.yaml) [


playkit-js-image-player is a [kaltura player] engine enabling [kaltura player] to play an image
playkit-js-image-player is written in [ECMAScript6] (.js) and [TypeScript] (.ts) (strongly typed superset of ES6),
and transpiled in ECMAScript5 using Babel and the [TypeScript compiler].
[Webpack] is used to build the distro bundle and serve the local development environment.
[kaltura player]: https://github.com/kaltura/kaltura-player-js.
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[typescript]: https://www.typescriptlang.org/
[typescript compiler]: https://www.typescriptlang.org/docs/handbook/compiler-options.html
[webpack]: https://webpack.js.org/
There are two modes an image playback can be played in the Kaltura player
image can be played as one of the following modes
- Non-Durational Image
- Durational image
Non-Durational Images will be displayed by the player without a seek bar and the standard player controls (except the full-screen button)
Durational Images will be played by the player as if it is a video,
with seek bar and all standard player controls
In fact it will behave just like a video for everything
If the image is played as part of a playlist, it will automatically play as a Durational Image with a default duration of 5 seconds
The image mode will be determined according to the duration configured with the entry
``shFirst, checkout the repository and install the required dependencies
git clone https://github.com/kaltura/playkit-js-image-player.git
The dev server will host files on port 8000. Once started, the demo can be found running at http://localhost:8000/.
Before submitting a PR, please see our contribution guidelines.
$3
Run linter:
`
npm run lint:check
`Run linter with auto-fix mode:
`
npm run lint:fix
`$3
Run prettier to format code
`
npm run prettier:fix
`$3
Run type-check to verify TypeScript types
`
npm run types:check
`$3
Run all tests at once:
`
npm test
`Run unit tests in watch mode:
`
npm run test:watch
``An overview of this project's design, can be found here.
https://kaltura.github.io/playkit-js-image-player/demo/index.html
playkit-js-image-player is supported on:
- Chrome 39+ for Android
- Chrome 39+ for Desktop
- Firefox 41+ for Android
- Firefox 42+ for Desktop
- IE11 for Windows 8.1+
- Edge for Windows 10+
- Safari 8+ for MacOS 10.10+
- Safari for ipadOS 13+
playkit-js-image-player is released under Apache 2.0 License