APIs

Show:

The PepperHelper class is used to manage real time data that is not in the msdb such as blocks and related methods that have to do with player_data which is a vital part of each channel or scene block (i.e.: player)

Constructor

PepperHelper

()

Returns:

none fasterq appId 12100 playerId 6100

Methods

_initComponents

()

The _initComponents initializes data constants for components and used to relieve member data such as mapping between component code and the type of resource it holds etc.

Returns:

none

getBlockBoilerplate

(
  • i_blockID
)
Object

Get a component data structure and properties for a particular component id.

Parameters:

  • i_blockID Number

Returns:

Object:

return the data structure of a specific component

getBlockCodeFromFileExt

(
  • i_fileExtension
)
Number

Retrieve a component code from a file extension type (i.e.: flv > 3100).

Parameters:

  • i_fileExtension String

Returns:

Number:

return component code

getBlocks

() Object

Get the entire set data structure for all components.

Returns:

Object:

return all data structure

getCommonBackgroundXML

() String

Get the common properties XML with all default values

Returns:

String:

common xml

getCommonBorderXML

() String

Get the common border XML with all default values

Returns:

String:

common xml

getCommonDefaultXML

() String

Get the common properties XML with all default values

Returns:

String:

common xml

getCommonSceneDefaultXML

() String

Get the common properties Scene XML with all default values

Returns:

String:

common xml

getCommonSceneLayout

(
  • i_placement
)
String

Get the common layout which only applies when block is inside a scene

Parameters:

  • i_placement String

Returns:

String:

common xml

getFontAwesome

(
  • i_fontName
)
String

Get the font awesome path

Parameters:

  • i_fontName String

Returns:

String:

url path

getFontsAwesome

() Object

Get the entire font awesome set

Returns:

Object:

data set

getIconFromMimeType

(
  • i_playerData
)
String

Translate a mimeType to a font-awesome icon of generic icons if does not exist

Parameters:

  • i_playerData Number

Returns:

String:

foundMimeIcon

playerDataTojson

(
  • i_playerData
)
Json

Convert player data to json format

Parameters:

  • i_playerData String

Returns:

Json:

jPlayerData

playerDataToxml

(
  • i_playerData
)
XML

Convert player data to xml format

Parameters:

  • i_playerData String

Returns:

XML:

xml data