digitalsignage.com - open source docs digitalsignage.com - open source docs

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    PepperHelper Class

    Defined in: _libs\PepperHelper.js:1

    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

    ()

    Defined in _libs\PepperHelper.js:1

    Returns:

    none fasterq appId 12100 playerId 6100

    Methods

    _initComponents

    ()

    Defined in _libs\PepperHelper.js:19

    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

    Defined in _libs\PepperHelper.js:705

    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

    Defined in _libs\PepperHelper.js:743

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

    Parameters:

    • i_fileExtension String

    Returns:

    Number:

    return component code

    getBlocks

    () Object

    Defined in _libs\PepperHelper.js:733

    Get the entire set data structure for all components.

    Returns:

    Object:

    return all data structure

    getCommonBackgroundXML

    () String

    Defined in _libs\PepperHelper.js:691

    Get the common properties XML with all default values

    Returns:

    String:

    common xml

    getCommonBorderXML

    () String

    Defined in _libs\PepperHelper.js:682

    Get the common border XML with all default values

    Returns:

    String:

    common xml

    getCommonDefaultXML

    () String

    Defined in _libs\PepperHelper.js:660

    Get the common properties XML with all default values

    Returns:

    String:

    common xml

    getCommonSceneDefaultXML

    () String

    Defined in _libs\PepperHelper.js:671

    Get the common properties Scene XML with all default values

    Returns:

    String:

    common xml

    getCommonSceneLayout

    (
    • i_placement
    )
    String

    Defined in _libs\PepperHelper.js:645

    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

    Defined in _libs\PepperHelper.js:763

    Get the font awesome path

    Parameters:

    • i_fontName String

    Returns:

    String:

    url path

    getFontsAwesome

    () Object

    Defined in _libs\PepperHelper.js:776

    Get the entire font awesome set

    Returns:

    Object:

    data set

    getIconFromMimeType

    (
    • i_playerData
    )
    String

    Defined in _libs\PepperHelper.js:716

    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

    Defined in _libs\PepperHelper.js:786

    Convert player data to json format

    Parameters:

    • i_playerData String

    Returns:

    Json:

    jPlayerData

    playerDataToxml

    (
    • i_playerData
    )
    XML

    Defined in _libs\PepperHelper.js:798

    Convert player data to xml format

    Parameters:

    • i_playerData String

    Returns:

    XML:

    xml data