Skip to main content

Player SDK

The Player SDK is a JavaScript library which provides communication between the app hosted within the Player's iframe with the hosting Player. It allows to fetch the value of the asset which is to be displayed, manage the app's lifecycle, fetch device's settings and others.

Development tips

The app using Player SDK has to be run inside of the Player's iframe to function properly as the SDK serves as a transport channel of the messages only. All commands are actually executed by the hosting Player. This means that running your app outside of the Player will not work. To run your app inside of the Player, you need to add it to the system. See Creating an App. After you create a new asset in the Dashboard part of the app and assign it to some Display Group, the app should start appearing in the Player.

Installing the Player SDK#

Include the Player SDK script in your app, by adding the following code to the <head> section of your app's HTML file:

Loading Player SDK into the project
<script type="text/javascript" src=""></script>

This will create a global enplug/window.enplug object providing various SDK methods for communicating with the hosting Player.

Type support#

If you use TypeScript and would like to have the typings checked in your IDE you can load the following NPM package:

npm install @enplug/sdk-player --save-dev

Then, add "@enplug/sdk-player" to the types array in your TypeScript config file. Make sure that typeRoots array has the "node_modules" entry, so that the whole path is available to the compiler.


After the Player SDK script gets loaded into your app, it will instantly create a global enplug/window.enplug object which gives you the access to the methods provided by the Player.

See more: enplug

Useful APIs#

Account API#

Use enplug.appStatus to manage app's lifecycle.

See more: enplug.appStatus

Assets API#

Use enplug.assets to fetch the value of the assets that is to be displayed or the selected theme.

See more: enplug.assets

Settings API#

Use enplug.settings to fetch the settings of the device and the player.


See more: enplug