Class PlayerClient

This method allows the gadget to communicate with player scripting. If the appropriate scripting is in place in the currently running template, calling this method will initiate a callback which can be acted upon in player script.

Example

client.callback('test', 'this');
Copy

Indicate to the player that this gadget has finished it's visualization. This allows the player to proceed with the next item in a playlist if applicable.

Returns a map of commands currently active for this device.

Returns the device details associated with the player running the gadget or web app.

Returns the unique Revel Digital device key associated with the device.

Returns the current device time in ISO8601 format. Current device time is determined by the device timezone assigned to the device in the CMS.

Returns the timezone ID currently assigned to the device.

Returns the timezone name currently assigned to the device.

Returns the numerical offset from GMT of the timezone currently assigned to the device.

Returns the language code of the language currently assigned to the device.

Accessor method for the user preferences interface exposed by the Gadgets API.

See https://developers.google.com/gadgets/docs/basic for more details on the Gadgets API.

Example

constructor(public client: PlayerClientService) {
           let prefs = client.getPrefs();
           let myString = prefs.getString('myStringPref');
}
Copy

Returns the root folder utilized by this player device.

Check is the gadget is running in preview mode. Preview mode is enabled when the gadget is being edited in the CMS, or otherwise not running in a normal player environment.

A session is a way of grouping events together. Each event has an associated session ID. Session ID's are randomly generated and reset by subsequent calls to newEventSession().

Each call to track() will utilize the same session ID, until another call to newEventSession().

Remove an event listener for the specified player event.

Add an event listener for the specified player event.

Send a command to the player device.

Send a command to any remote player with the supplied device key(s). Note: Remote commands can only be delivered to devices within the same account as the sender device.

Method for initiating a timed event. Timed events are useful for tracking the duration of an event and must be proceeded with a call to track().

Example

client.timeEvent('testEvent');
client.track("test", { "a": "b" });
Copy

Log an event for use with AdHawk analytics. Events are used for tracking various metrics including usage statistics, player condition, state changes, etc.