‘destroy’ Event

The “destroy” event is fired anytime the application is going to be disposed by the player. When developing a player application with the JavaScript SDK, you should be prepared for your app to be destroyed anytime it is taken off of the display. The player will fire the “destroy” event and then wait for a small amount of time to allow you to do any cleanup. To notify the player you are done with any final processes, a callback is passed to the event handler. If you do not call the callback, your app will still be removed once the allotted cleanup time has passed. Every JavaScript Player application should attach a handler, if only to call the done callback.

enplug.on( 'destroy', function( done ) {
  // maybe save some state information
  localStorage.setItem( 'last-viewed', view.id );
  done(); // ok! I'm ready to be destroyed...
});

enplug.on( eventName, handler ) : undefined

The on function can be used to attach a new handler for a specific event by that event’s name. If you wish to remove this event handler at any time, you will need to keep a reference to the handler function and pass it into the off function (described below).

• eventName: The name of the event the handler should be bound to.

• handler: The function to handle incoming events of type “eventName”.

enplug.off( eventName, handler ) : undefined

The off function is used to remove existing event handlers. It is important to note that a reference to the original event handler must be passed to off for the handler to be removed.

• eventName: The name of the event the handler should be bound to.

• handler: The function to handle incoming events of type “eventName”.

enplug.once( eventName, handler ) : undefined

The once function is a convenience function for adding an event handler that gets automatically removed after the first time it is fired. The code below is the functional equivalent of the once function’s functionality.

enplug.notifications.post( message ) : Promise<notificationid>

The post function will take a single argument, the message to display. The message should be as simple as possible to keep the notification short and sweet. The icon used when registering the application in the Enplug App Store will be used as the icon for the notification.

• **message:** The message to display in the notification.

enplug.appStatus.start() : Promise<boolean>

When an app is first started by the Enplug Player it will not be shown on screen until it explicitly tells the player that it is ready to be rendered. Note that initially apps are loaded off screen so they can be given time to properly initialize. When you have set up your application and are ready to be shown on the Enplug Player call the start function to be entered into the current rotation of active Player Applications. 

Returns a Promise that resolves to true if the operation has completed successfully.

enplug.appStatus.error() : Promise<boolean>

It is important to notify the player if your application has reached an unresolvable error. Calling the error function will notify the Enplug Player that your application is not operating properly and should be removed from the current rotation of Player Applications. Calling error will typically end up with your application being disposed and destroyed from working memory. 

Returns a Promise that resolves to true if the operation has completed successfully.

enplug.appStatus.hide() : Promise<boolean>

If ever you want to immediately hide your application the hide function can be called to do so. Calling this function will hide your application until it comes up in the normal application rotation cycle. If your app is the only app playing on the display it will not be hidden. 

A Promise that resolves to true when the app has been hidden from the screen.

enplug.appStatus.setCanInterrupt( boolean ) : Promise

Sometimes your app will be displaying a video or some other content that should not be interrupted. If you wish to stop the Enplug Player from replacing your app on screen, use the canInterrupt property and setCanInterrupt function of the enplug.appStatus object.

The canInterrupt property is returned as a promise resolving to a boolean value. The setCanInterrupt function takes the new boolean value and returns a Promise resolving to the new value. It is safe to assume that this value takes hold as soon as it is set. Typically you will only set the value when needed.

myVideo.addEventListener( 'play', function( playEvent ) {
  enplug.appStatus.setCanInterrupt( false ); // returns a Promise
});
myVideo.addEventListener( 'ended', function( endEvent ) {
  enplug.appStatus.setCanInterrupt( true ); // returns a Promise
});
myVideo.play();

enplug.appStatus.canInterrupt: Promise<boolean>

Checks the current state of canInterrupt property. Returns promise resolving to true if the app had requested not to be interrupted and false otherwise.

enplug.appStatus.canInterrupt.then(function( canInterrupt ) {
  // here the value of canInterrupt will be true or false
  // depending on the previously set value
  // this value always initializes as true
});

enplug.appStatus.getTrigger(): Promise<object>

Returns the reason why an app was rendered on-screen. It is used for Social CMS apps. The response will contain a reason and data property. Check the value of the reason property to determine if this is a new item (reason: "event").

For example, a response to getTrigger() from a social app will contain the following:

{
  reason:("schedule"|"event"),
  data: {
    Id, 
    SocialNetwork,
    SocialItemId,
    FeedId,
    CreatedTime,
    LastSavedTime,
    CreatedTime,
    ProfanityCount,
    ProfaneWords,
    IsApproved,
    IsAllowed,
    SecondaryText,
    ImageLocalPath,
    UserImageLocalPath
    }
}

enplug.assets.getNext() : Promise<object>

Iterates through the list of asset values defined in the Dashboard part of your application for this display. Each time when called will get the next asset in the list of assets. 
Returns a promise that resolves to the single asset value (an Object).

.enplug.settings.all {Promise<object>}

This Promise will resolve to an Object with all of the app's settings. Additional information about these settings are outlined further below.

enplug.settings.all.then(function( settings ) {
  // returns all the app's setting in one API method call
});

{
 is4k,
 transitionType,
 whitelabel,
 locale,
 zoningInfo,
 orientation,
 isMuted
};

• is4K: A boolean if the Enplug Player is connected to a 4K display (true) or (false).

• transitionType: The current display group's saved animation used by the Enplug Player to transition between applications.

• whitelabel: The value of the white label set for a given Enplug Player.

• locale: The saved language for the current display group playing the app.

• zoningInfo: An object containing the app's width, height , size, and zone, available for both zoning widgets ( ticker or banner ) as well as the main app. 
  
  For the main app, it will return a zone value of "main" and  the app's dimensions (width and height ).

  {
    width: 480,
    height: 1080,
    size: 4,
    zone: 'banner'
  }

  • width: Width of the current app.

  • height: Height of the current app.

  • size: Returns a value for the zone widget size. Possible banner values include 1,2,3,4 with 1 representing the smallest size (1/4 of the possible banner size) and 4 as the largest.

  • zone: Returns the current zone widget or main app. Possible values include  "banner", "ticker" or "main".

• orientation: The display group's set orientation (portrait or landscape ).

• isMuted: A boolean if the Enplug Player is connected to a display which is muted (true) or (false) if it is not.

.enplug.settings.is4k {Promise<boolean>}

Note: This method is now obsolete. Please use enplug.settings.all instead.

This Promise property can be checked to know if the Enplug Player is connected to a 4K display so you can update your application accordingly, possibly with high resolution graphics or different font settings, etc.

enplug.settings.is4K.then(function( is4K ) {
  // is4K will be:
  //   true when connected to a 4K display
  //   false when connected to a non-4K display
});

enplug.settings.transitionType.then(function( type ) {
  // type will be a string and one of the following
  //  'SLIDE_LEFT'
  //  'SLIDE_RIGHT'
  //  'SLIDE_DOWN'
  //  'SLIDE_UP'
  //  'FADE'
  //  'NONE'
});

.enplug.settings.whitelabel {Promise<string>}

Note: This method is now obsolete. Please use enplug.settings.all instead.

Many Enplug apps show a small white label overlay at the bottom of the display. This can be customized for certain users. This property can be checked to get the value of the white label as set for given Enplug Player.

enplug.settings.whitelabel.then(function( value ) {
  // here value will be a string representing the white label for this display
});

.enplug.settings.hideWhiteLabel {Promise<boolean>}

Hides the white label overlay at the bottom of the display. 

enplug.settings.hideWhitelabel().then(function( isHidden ) {
  // returns a boolean if the white label has been successfully hidden
});

enplug.settings.locale.then(function( value ) {
  // the device locale will be returned here 
});

enplug.settings.zoning.then(function( info ) {
  // the zoning info will be returned here 
});

{
  width: 480,
  height: 1080,
  size: 4,
  zone: 'banner'
}

enplug.settings.deviceId.then(function( value ) {
  // the device id will be returned here 
});

Play Recorder

The Play Recorder API can be used to record how long a particular screen was shown on a display. An example would be recording how long an advertisement was displayed on screen to properly pay the screen provider.