@sklera/sdk 1.6.11 | Documentation

@sklera/sdk

1.6.11

skleraSDK ▸
requestCallback
EventLogTypes

skleraSDK

Library to communicate with the sklera Player

skleraSDK

Example

skleraSDK.loaded(function(screenData, appConfig) {
     console.log('SDK ready!');
     console.log(screenData);
     console.log('runtime config:', appConfig);
 })

Static Members

▸ loaded(callback)

Triggers after Data is loaded

loaded(callback: Function): Promise<{}>

Parameters

callback (Function) Callback with parameters screenData and appConfig set

Returns

Promise<{}>

▸ getConfig()

Get the current Settings for the app

getConfig(): any

Returns

any: appConfig

▸ loadConfig(callback)

Loads the current Settings for the app

loadConfig(callback: Function): Promise<any>

Parameters

callback (Function)

Returns

Promise<any>

▸ writeData(key, data, callback)

Store text data on the player (uses localStorage)

writeData(key: String, data: any, callback: Function)

Parameters

key

(String
            = "")

Date key

data (any)

callback (Function)

▸ readData(key, callback)

Read text data from the player (uses localStorage)

readData(key: String, callback: Function)

Parameters

key

(String
            = "")

callback (Function)

▸ hideApp()

Hide this WebApp

hideApp()

▸ showApp()

Show this WebApp

showApp()

▸ setFullscreen()

Enter fullscreen mode for the app widget

setFullscreen()

▸ unsetFullscreen()

Leave fullscreen mode for the app widget

unsetFullscreen()

▸ toggleFullscreen()

Toggle fullscreen mode for the app widget

toggleFullscreen()

▸ setAppWidgetOrder(orderPosition?)

Sets the widget order position

setAppWidgetOrder(orderPosition: string?)

Parameters

orderPosition (string?) set position. Allowed values: 'foreground', 'background' or 'default'. Empty means 'default'

▸ pausePlayer()

Pause Player

pausePlayer()

▸ resumePlayer()

Resume Player

resumePlayer()

▸ logEvent(eventType, eventData, callback?)

Log player touch or itemPlayed events (Player version > 3.9.36) Update: 18.08.2023 new generic player log types: PLAYER_EVENT_ERROR, PLAYER_EVENT_WARNING, PLAYER_EVENT_INFO

logEvent(eventType: (EventLogTypes | string), eventData: any, callback: any?): any

Parameters

eventType ((EventLogTypes | string))

eventData (any) {Object} optional data, {itemId}

callback (any?)

Returns

any

▸ getItems(callback)

Get Library Items

getItems(callback: requestCallback)

Parameters

callback (requestCallback)

▸ getMediaItems(callback)

Get Downloaded Media Files

getMediaItems(callback: requestCallback)

Parameters

callback (requestCallback)

▸ getCollectionData(collection, filter?, options?, callback)

Get Library Documents (Database)

getCollectionData(collection: string, filter: Object?, options: Object?, callback: requestCallback)

Parameters

collection (string) Collection-name

filter (Object?) Mongo-DB Filter

options (Object?) Mongo-DB Options

callback (requestCallback)

▸ getWidgetsByName(name, callback)

Get Widgets by Name

getWidgetsByName(name: string, callback: requestCallback)

Parameters

name (string) Widget name

callback (requestCallback)

▸ getWidgetList(callback)

Get all Widgets

getWidgetList(callback: requestCallback)

Parameters

callback (requestCallback)

▸ overrideWidgetData(widgetId, data)

Override Widget Data

overrideWidgetData(widgetId: string, data: object)

Parameters

widgetId (string)

data (object)

▸ resetWidgetData(widgetId)

Reset Widget Data

resetWidgetData(widgetId: string)

Parameters

widgetId (string)

▸ setPhilipsLed(color)

Enable LED of Philips 10BDL3051T with specified RGB color

setPhilipsLed(color: string)

Parameters

color (string) RGB HEX Code of desired color e.g. FF0000 for red

▸ unsetPhilipsLed()

Disable LED of Philips 10BDL3051T

unsetPhilipsLed()

▸ fetchRemoteData(url, config?, callback)

Fetch remote text data (json or xml) via http request (CORS disabled). Player Version > 3.7.26 required. May currently only work on linux players.

fetchRemoteData(url: string, config: Object?, callback: requestCallback): Promise<any>

Parameters

url (string) Remote Url

config (Object?) optional fetch config

callback (requestCallback)

Returns

Promise<any>

▸ sendHttpRequest(url, config?, callback)

Send HTTP request (CORS disabled). Player Version > 3.8.16 required.

sendHttpRequest(url: string, config: Object?, callback: requestCallback): Promise<any>

Parameters

url (string) Remote Url

config (Object?) optional config.method, config.headers, config.params

callback (requestCallback)

Returns

Promise<any>

▸ getCustomValue(key, callback)

Get CustomValue (Database) Player Version > 3.8.16 required.

getCustomValue(key: string, callback: requestCallback): any

Parameters

key (string) CustomValue key name

callback (requestCallback)

Returns

any

▸ setCustomValue(key, value, optionsOrScope, callback)

Set CustomValue (Database) Player Version > 3.8.16 required.

Change 28.09.2021: Since SDK version 1.2.1 and Player Version 3.9.17: 3rd parameter can be an options object for setting permission level (public or private), example: {scope: 'screen', isPublic: false}

setCustomValue(key: string, value: string, optionsOrScope: (string | Object), callback: requestCallback)

Parameters

key (string) CustomValue key name

value (string) new value

optionsOrScope ((string | Object)) scope (screen, channel) or options {scope: string, isPublic: boolean}

callback (requestCallback)

▸ getChannelCategories(callback)

Get all Channel categories > 3.8.16 required.

getChannelCategories(callback: requestCallback)

Parameters

callback (requestCallback)

▸ getScreenCategories(callback)

Get Screen categories > 3.8.16 required.

getScreenCategories(callback: requestCallback)

Parameters

callback (requestCallback)

▸ addScreenCategories(categoryIds, callback)

Add Screen category > 3.8.16 required.

addScreenCategories(categoryIds: (string | Array<string>), callback: requestCallback)

Parameters

categoryIds ((string | Array<string>))

callback (requestCallback)

▸ removeScreenCategories(categoryIds, callback)

Remove Screen category > 3.8.16 required.

removeScreenCategories(categoryIds: (string | Array<string>), callback: requestCallback)

Parameters

categoryIds ((string | Array<string>))

callback (requestCallback)

▸ setScreenCategories(categoryIds, callback)

SET Screen categories > 3.8.16 required.

setScreenCategories(categoryIds: Array<string>, callback: requestCallback): any

Parameters

categoryIds (Array<string>)

callback (requestCallback)

Returns

any

▸ clearScreenCategories(callback)

Clear all Screen categories > 3.8.16 required.

clearScreenCategories(callback: requestCallback)

Parameters

callback (requestCallback)

▸ setScreenSystemValues(data, callback, key, value)

Set System value for screen > 3.8.16 required.

setScreenSystemValues(data: any, callback: requestCallback, key: string, value: string)

Parameters

data (any)

callback (requestCallback)

key (string) key name

value (string) new value

▸ getCachedFile(id, callback)

Get previous local cached file by id > 3.8.86 required.

getCachedFile(id: string, callback: requestCallback)

Parameters

id (string) file name

callback (requestCallback)

▸ cacheFile(opt, callback?)

Cache/store a file locally > 3.8.86 required.

cacheFile(opt: object, callback: requestCallback?)

Parameters

opt (object) opt.url required, optional opt.id, opt.cacheDays, opt.override

callback (requestCallback?)

▸ getItemData(itemId, callback)

Get a data ressource URL of a local stored media item (image or video) by ID. Version > 3.8.86 required.

getItemData(itemId: string, callback: requestCallback): any

Parameters

itemId (string) ID of library item

callback (requestCallback) , data.url can be used in image or video tags as source

Returns

any

▸ getFolderData(folderId, callback)

Get Folder data (subfolders and items) > 3.9.32 required.

getFolderData(folderId: string, callback: requestCallback)

Parameters

folderId (string)

callback (requestCallback)

▸ getDataURL(dataId, callback)

Get the Data from a Data URL entry in the CMS via ID. >4.0 required

getDataURL(dataId: string, callback: requestCallback)

Parameters

dataId (string)

callback (requestCallback)

▸ loadFont(fontId, fontName?, callback)

Get a data ressource URL of a local stored media item (image or video) by ID. Version > 3.8.86 required.

loadFont(fontId: string, fontName: string?, callback: requestCallback)

Parameters

fontId (string) ID of font

fontName (string?) Font Family name

callback (requestCallback) , data returns font-family name

▸ getPublicDownloadLink(itemId, callback)

Get public downlod link for item

getPublicDownloadLink(itemId: string, callback: requestCallback)

Parameters

itemId (string)

callback (requestCallback)

▸ triggerTouchAction(widgetNameOrId, callback)

Trigger touch action of an widget by name OR id in the running layout context. player version > 3.8.154 required.

triggerTouchAction(widgetNameOrId: string, callback: requestCallback)

Parameters

widgetNameOrId (string) name or ID of widget

callback (requestCallback)

▸ triggerTouchActionDirect(actions, callback)

EXPERIMENTAL - Trigger raw touch action; version > 3.9.9 required.

desc

 TYPE SHOW_ELEMENT show element example
 skleraSDK.triggerTouchActionDirect([{type: 'SHOW_ELEMENT', itemId: data.itemId, duration: 0}]);
 TYPE WEBHOOK call webhook from player with public url of item
 skleraSDK.triggerTouchActionDirect([{type: 'WEBHOOK', itemId: data.itemId, webhookUrl:'https://sklera.tv?image=__ITEM_URL__',webhookData:'{}',webhookType:'GET',webhookMode: 'CLIENT'}]);
 webhookUrl: string url of resource
 webhookType: string method of http request GET|PUT|POST|DELETE
 webhookData: string JSON data for http request {key: value}
 webhookHeader: string JSON http header data {key: value}
 webhookMode: string [CLIENT|SERVER] defines http request origin (player or server)
 itemId: string optional item id for url replacement

triggerTouchActionDirect(actions: array, callback: requestCallback)

Parameters

actions (array) raw touch action config array

callback (requestCallback)

▸ resetSessionCountdown(callback)

Resets the interactive session countdown of screen layouts (if available)

Background: When using HTML5 App this should be called every time the user touches (is active) in the app - our player can't detect touch/click events happening within the app.

resetSessionCountdown(callback: requestCallback)

Version: > 3.9.36

Parameters

callback (requestCallback)

▸ setVirtualStandby(enabled, callback)

Switch display panel on or off

setVirtualStandby(enabled: boolean, callback: requestCallback)

Version: > 4.1.52

Parameters

enabled (boolean) true=display off

callback (requestCallback)

▸ onCustomAppEvent(listener, cmdFilter?)

Listen on custom App events

onCustomAppEvent(listener: Function, cmdFilter: string?): Object

Parameters

listener (Function) callback

cmdFilter (string?) filter for cmd

Returns

Object: listernRef

▸ unsubscribeCustomAppEvent(listenerRef)

Unsubsribe custom App event

unsubscribeCustomAppEvent(listenerRef: object)

Parameters

listenerRef (object) listerner Reference

▸ sendCustomAppMessage(cmd, data)

Send App Message to other Apps

sendCustomAppMessage(cmd: string, data: any)

Parameters

cmd (string) Message Cmd

data (any) Any data

▸ onSpotStateChange(listener)

Registers a listener that will be called whenever the spot state changes.

Possible states:

"begin" – Spot is starting (app in playlist)
"showing" – Spot is currently playing (app in playlist)
"ending" – Spot is finishing (app in playlist)
"current" – Current spot (app in layout, current spot in playout)

onSpotStateChange(listener: function (state: ("begin" | "showing" | "ending" | "current"), data: {itemName: string, playlistName: string, durationSeconds: number, rawData: any}): void)

Parameters

listener

(function (state: ("begin" | "showing" | "ending" | "current"), data: {itemName: string, playlistName: string, durationSeconds: number, rawData: any}): void)

Callback function invoked on every state change.

Name	Description
listener.state `any`	The new spot state.
listener.data `any`	Optional additional information about the currentspot.
listener.data.itemName `any`	Name of the spot item.
listener.data.playlistName `any`	Name of the playlist containing the spot.
listener.data.durationSeconds `any`	Duration of the spot in seconds.
listener.data.rawData `any`	Raw event data from the backend or player.

Example

const unsubscribe = onSpotStateChange((state, data) => {
  console.log("State:", state);
  if (data) {
    console.log("Spot:", data.itemName, "Playlist:", data.playlistName);
  }
});

▸ viewElement(nameIdOrQuery, options, callback)

Play element on sklera Player / Playout-Widget

viewElement(nameIdOrQuery: string, options: any, callback: requestCallback)

Parameters

nameIdOrQuery (string) query item with name or id

options (any)

callback (requestCallback)

▸ printApp(options, callback)

Print App content (Electron-Player only)

printApp(options: Object, callback: requestCallback)

Parameters

options (Object) Electron Print Options ( https://www.electronjs.org/docs/latest/api/web-contents#contentsprintoptions-callback )

callback (requestCallback)

▸ focusApp(callback)

Sets focus on the app (Electron-Player only)

focusApp(callback: requestCallback)

Parameters

callback (requestCallback)

requestCallback

This callback type is called requestCallback and is displayed as a global symbol.

requestCallback(errorResponse: string, responseData: string)

Type: Function

Parameters

errorResponse (string) Error Response. If null, Response is ok

responseData (string) Data

EventLogTypes

Event Log types

EventLogTypes

Type: string

Properties

TOUCH_ACTION_GENERIC (string) : log touch action: generic action

TOUCH_ACTION_SHOW_ELEMENT (string) : log touch action: show Element

ITEM_PLAYED (string) : log item played event

PLAYER_EVENT_ERROR (string) : log an error event; eventData {data}

PLAYER_EVENT_WARNING (string) : log a warning event; eventData {data}

PLAYER_EVENT_INFO (string) : log a info event; eventData {data}