https://github.com/kaltura/playkit-js-ima
IMA Plugin for the Kaltura Player JS
https://github.com/kaltura/playkit-js-ima
es6 flow-typed ima-sdk kaltura playkit playkit-js playkit-js-player
Last synced: 3 months ago
JSON representation
IMA Plugin for the Kaltura Player JS
- Host: GitHub
- URL: https://github.com/kaltura/playkit-js-ima
- Owner: kaltura
- License: agpl-3.0
- Created: 2017-03-16T18:39:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T11:36:39.000Z (6 months ago)
- Last Synced: 2025-06-02T05:53:22.742Z (4 months ago)
- Topics: es6, flow-typed, ima-sdk, kaltura, playkit, playkit-js, playkit-js-player
- Language: JavaScript
- Homepage:
- Size: 4.77 MB
- Stars: 4
- Watchers: 22
- Forks: 7
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PlayKit JS IMA - IMA Plugin for the [Kaltura Player JS]
[](https://github.com/kaltura/playkit-js-ima/actions/workflows/run_canary_full_flow.yaml)
[](https://github.com/prettier/prettier)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-ima)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-ima/v/canary)
PlayKit JS IMA plugin integrates [IMA SDK for HTML5] with the [Kaltura Player JS].
PlayKit JS IMA is written in [ECMAScript6], statically analysed using [Flow] and transpiled in ECMAScript5 using [Babel].
[ima sdk for html5]: https://developers.google.com/interactive-media-ads/docs/sdks/html5/
[flow]: https://flow.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io
[kaltura player js]: https://github.com/kaltura/kaltura-player-js
## Getting Started
### Prerequisites
The plugin requires [Kaltura Player JS] to be loaded first.
The plugin uses the [IMA SDK for HTML5] Javascript SDK, if the SDK is already loaded on the page the plugin will use it, and if it's not then it will load it.
### Installing
First, clone and run [yarn] to install dependencies:
[yarn]: https://yarnpkg.com/lang/en/
```
git clone https://github.com/kaltura/playkit-js-ima.git
cd playkit-js-ima
yarn install
```
### Building
Then, build the player
```javascript
yarn run build
```
### Embed the library in your test page
Finally, add the bundle as a script tag in your page, and initialize the player
```html
var config = {
provider: {
partnerId: {YOUR_PARTNER_ID}
...
},
...
plugins: {
ima: {
adTagUrl: 'YOUR_AD_TAG_URL'
}
}
...
};
var player = KalturaPlayer.setup(config);
player.play();
```
## Documentation
- **[Configuration & API](docs/api.md)**
- **[Guides](docs/guides.md)**
## Running the tests
Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari
[karma]: https://karma-runner.github.io/1.0/index.html
```
yarn run test
```
You can test individual browsers:
```
yarn run test:chrome
yarn run test:firefox
yarn run test:safari
```
### And coding style tests
We use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.
See [ESLint config](.eslintrc.json) for full configuration.
We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
## Compatibility
TBD
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-ima/tags).
## License
This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details
```
```