Pepper

Defined in: _libs\Pepper.js:1

Pepper SDK is a collection of files that provide a wrapper for the Soap API used to communicate with MediaSignage servers. The SDK makes programming easier by abstracting some of the tedious tasks such as enumeration.

The msdb internal Database is the magic sauce as it maps against the actual mediaSERVER remote database via local generated handles (a.k.a IDs). Once a user saves the local configuration, the local Database is serialized and pushed onto the a remote mediaSERVER. This allows for the user to work offline without the need for constant network communication until a save is initiated.

The internal database is referenced as msdb in both code and documentation.

Library requirements: composition: x2js, jQuery inheritance: ComBroker

Constructor

`Pepper`

() Object

Defined in _libs\Pepper.js:1

Returns:

Object:

Pepper instance

Item Index

Methods

Events

Pepper.BLOCK_LENGTH_CHANGED static
Pepper.NEW_CAMPAIGN_CREATED static
Pepper.NEW_CHANNEL_ADDED static
Pepper.NEW_CHANNEL_CREATED static
Pepper.NEW_PLAYER_CREATED static
Pepper.NEW_TEMPLATE_CREATED static
Pepper.NEW_TIMELINE_CREATED static
Pepper.REMOVE_TIMELINE_CHANNEL_BLOCK static
Pepper.SAVE_TO_SERVER static
Pepper.TIMELINE_DELETED static
Pepper.TIMELINE_LENGTH_CHANGED static
Pepper.TIMELINE_LENGTH_CHANGED static
Pepper.TIMELINE_LENGTH_CHANGED static
Pepper.TIMELINE_SCHEDULE_DELETED static

Methods

`_livePreviewGetLink`

(

i_playerParams
i_bannerMode

)

String

Defined in _libs\Pepper.js:537

Build URL for player preview using supplied player parameters

Parameters:

i_playerParams String
i_bannerMode Number

Returns:

String:

url

`announceTemplateViewerEdited`

(

i_campaign_timeline_board_template_id

)

Defined in _libs\Pepper.js:1126

Announce via event that a template view (screen layout) has been edited

Parameters:

i_campaign_timeline_board_template_id Number

`appendScenePlayerBlock`

(

i_scene_id
i_player_data

)

Defined in _libs\Pepper.js:827

append scene player block to pepper player_data table

Parameters:

i_scene_id Number
i_player_data XML

`assignCampaignToBoard`

(

i_campaign_id
i_board_id

)

Number

Defined in _libs\Pepper.js:1171

Assign a campaign to a board, binding the to by referenced ids

Parameters:

i_campaign_id Number

the campaign id to assign to board
i_board_id Number

the board id to assign to campaign

Returns:

Number:

campain_board_id

`assignTemplateToTimeline`

(

i_campaign_timeline_id
i_board_template_id
i_campaign_board_id

)

Number

Defined in _libs\Pepper.js:1581

Bind the template (screen division template)to the specified timeline (i_campaign_timeline_id). We need to also provide the board_template_id (screen template of the global board) as well as the campaign's board_id to complete the binding

Parameters:

i_campaign_timeline_id Number

to assign to template
i_board_template_id Number

is the global board id (does not belong to campaign) to assign to the template
i_campaign_board_id Number

is the campaign specific board id that will be bound to the template

Returns:

Number:

campaign_timeline_board_template_id

`assignViewersToTimelineChannels`

(

i_campaign_timeline_board_template_id
i_viewers
i_channels

)

Defined in _libs\Pepper.js:1621

Assign viewers (screen divisions) on the timeline to channels, so we get one viewer per channel

Parameters:

i_campaign_timeline_board_template_id Number
i_viewers Object

a json object with all viewers
i_channels Array

a json object with all channels

Returns:

none

`assignViewerToTimelineChannel`

(

i_campaign_timeline_board_template_id
i_viewers
i_channels

)

Defined in _libs\Pepper.js:1603

Assign viewer (screen division) on the timeline to channel

Parameters:

i_campaign_timeline_board_template_id Number
i_viewers Object

a json object with all viewers
i_channels Array

a json object with all channels

Returns:

none

`calcTimelineTotalDuration`

(

i_campaign_timeline_id

)

Defined in _libs\Pepper.js:2599

Update a timeline's duration which is set as the total sum of all blocks within the longest running channel

Parameters:

i_campaign_timeline_id Number

Returns:

none

`ChangeBusinessName`

(

i_callBack

)

Defined in _libs\Pepper.js:476

Get business user info

Parameters:

i_callBack Function

`ChangePassword`

(

i_callBack

)

Defined in _libs\Pepper.js:466

Get business user info

Parameters:

i_callBack Function

`checkAndCreateCampaignTimelineScheduler`

(

i_campaign_id

)

Defined in _libs\Pepper.js:1711

Check that every timeline within a campaign has a scheduler table entry, if not, create one with default values

Parameters:

i_campaign_id Number

Returns:

none

`createAccount`

(

i_callBack

)

Defined in _libs\Pepper.js:419

Create a new mediaCLOUD account

Parameters:

i_callBack Function

`createBoard`

(

i_boardName
i_width
i_height

)

Number

Defined in _libs\Pepper.js:1152

Create a new board, also known as Screen (screen divisions reside inside the board as viewers)

Parameters:

i_boardName Number
i_width Number

of the board
i_height Number

of the board

Returns:

Number:

the board id

`createCampaign`

(

i_campaginName

)

Number

Defined in _libs\Pepper.js:1136

Create a new campaign in the local database

Parameters:

i_campaginName Number

Returns:

Number:

campaign id created

`createCampaignTimelineScheduler`

(

i_campaign_id
i_campaign_timeline_id

)

Defined in _libs\Pepper.js:1736

Create a campaign timelime scheduler record for new timeline

Parameters:

i_campaign_id Number
i_campaign_timeline_id Number

Returns:

none

`createNewChannelPlayer`

(

i_campaign_timeline_chanel_id
i_playerCode
i_offset
i_resourceID
i_sceneID

)

Object

Defined in _libs\Pepper.js:1403

Create a new player (a.k.a block) and add it to the specified channel_id

Parameters:

i_campaign_timeline_chanel_id Number

is the channel id assign player to
i_playerCode Number

is a unique pre-set code that exists per type of block (see component list for all available code)
i_offset Number

set in seconds of when to begin playing the content with respect to timeline_channel
i_resourceID Number

optional param used when creating a block with embedded resource (i.e.: video / image / swf)
i_sceneID Number

optional param used when creating a block with embedded scene

Returns:

Object:

campaign_timeline_chanel_player_id and campaign_timeline_chanel_player_data as json object

`createNewTemplate`

(

i_board_id
i_screenProps

)

Object

Defined in _libs\Pepper.js:1308

Create a new global template (screen and viewers) and assign the new template to the given global board_id

Parameters:

i_board_id Number
i_screenProps Object

json object with all the viewers and attributes to create in msdb

Returns:

Object:

returnData encapsulates the board_template_id and board_template_viewer_ids created

`createNewTimeline`

(

i_campaign_id

)

Number

Defined in _libs\Pepper.js:1386

Create a new timeline under the specified campaign_id

Parameters:

i_campaign_id Number

Returns:

Number:

campaign_timeline_id the timeline id created

`createPseudoSceneID`

(

getSceneIdFromPseudoId

)

Number

Defined in _libs\Pepper.js:902

Translate an injected id to a table_player_data scene id

Parameters:

getSceneIdFromPseudoId Number

Returns:

Number:

scene id

`createScene`

() Number

Defined in _libs\Pepper.js:709

Create a new Scene If mimetype was give as an argument and it's of format Json.xxxx (i.e.: Json.weather, Json.spreadsheet ...) add it to scene table as well

Returns:

Number:

scene player_data id

`createTimelineChannel`

(

i_campaign_timeline_id

)

Array

Defined in _libs\Pepper.js:1264

Create channel and assign that channel to the specified timeline

Parameters:

i_campaign_timeline_id Number

the timeline id to assign channel to

Returns:

Array:

createdChanels array of channel ids created

`createTimelineChannels`

(

i_campaign_timeline_id
i_viewers

)

Array

Defined in _libs\Pepper.js:1284

Create channels and assign these channels to the timeline

Parameters:

i_campaign_timeline_id Number

the timeline id to assign channel to
i_viewers Object

we use viewer as a reference count to know how many channels to create (i.e.: one per channel)

Returns:

Array:

createdChanels array of channel ids created

`createViewer`

(

board_template_id
i_board_template_id
i_props

)

Number

Defined in _libs\Pepper.js:1351

Create a global viewer in an existing board_template

Parameters:

board_template_id Number
i_board_template_id Number
i_props Object

Returns:

Number:

viewer id

`dbConnect`

(

i_user
i_pass
i_callBack

)

Defined in _libs\Pepper.js:172

Authenticate through mediaSERVER

Parameters:

i_user String
i_pass String
i_callBack Function

Returns:

none

`event`

(

i_event
i_context
i_caller
i_data

)

!~YUIDOC_LINE~! return $.Event(i_event, context: i_context, caller: i_caller, edata: i_data

Defined in _libs\Pepper.js:2965

The jQuery.Event constructor is exposed and can be used when calling trigger. The new operator is optional.

Parameters:

i_event Event
i_context Object
i_caller Object
i_data Object

Returns:

!~YUIDOC_LINE~! return $.Event(i_event, context: i_context, caller: i_caller, edata: i_data:

none.

event: function (i_event, i_context, i_caller, i_data) ); },

`formatObjectToSeconds`

(

i_object

)

Number

Defined in _libs\Pepper.js:2698

Format an object to seconds

Parameters:

i_object Object

with hours minutes and seconds key / values

Returns:

Number:

`formatSecondsToObject`

(

i_totalSeconds

)

Object

Defined in _libs\Pepper.js:2713

Format a seconds value into an object broken into hours / minutes / seconds

Parameters:

i_totalSeconds Number

Returns:

Object:

`generateSceneId`

() Number

Defined in _libs\Pepper.js:861

Get a unique scene > player id

Returns:

Number:

Unique scene player id

`getAdPackContNames`

(

i_ad_local_content_id

)

Object

Defined in _libs\Pepper.js:2369

Get station name from msdb (no remote server async)

Parameters:

i_ad_local_content_id Number

Returns:

Object:

`getAssignedViewerIdFromChannelId`

(

i_campaign_timeline_channel_id

)

Number

Defined in _libs\Pepper.js:2922

Get the assigned viewer id to the specified channel

Parameters:

i_campaign_timeline_channel_id Number

Returns:

Number:

foundViewerID

`getBlockRecord`

(

i_block_id

)

Object

Defined in _libs\Pepper.js:1536

Get a block's record using it's block_id

Parameters:

i_block_id Object

Returns:

Object:

recBlock

`getBlockTimelineChannelBlockLength`

(

i_campaign_timeline_chanel_player_id

)

Object

Defined in _libs\Pepper.js:2685

Get a block's (a.k.a player) total hours / minutes / seconds playback length on the timeline_channel.

Parameters:

i_campaign_timeline_chanel_player_id Number

Returns:

Object:

playbackLength as a json object with keys of hours minutes seconds

`getBoardFromCampaignBoard`

(

i_campaign_board_id

)

Number

Defined in _libs\Pepper.js:1210

Get a campaign_board into it's matching pair in global boards.

Parameters:

i_campaign_board_id Number

Returns:

Number:

board_id

`getBoardTemplateViewer`

(

i_board_template_viewer_id

)

Number

Defined in _libs\Pepper.js:1482

Get a Board Template Viewer props

Parameters:

i_board_template_viewer_id Number

Returns:

Number:

i_props

`GetBusinessUserInfo`

(

i_callBack

)

Defined in _libs\Pepper.js:456

Get business user info

Parameters:

i_callBack Function

`GetBusinessUserInfo`

(

i_callBack

)

Defined in _libs\Pepper.js:486

Get business user info

Parameters:

i_callBack Function

`GetBusinessUserInfo`

(

i_callBack

)

Defined in _libs\Pepper.js:446

Get business user info

Parameters:

i_callBack Function

`getCampaignIdFromCampaignBoardId`

(

i_campaign_board_id

)

Number

Defined in _libs\Pepper.js:1222

Get i_campaign_board_id into campaign_id using local table_campaign_boards (not global boards)

Parameters:

i_campaign_board_id Number

Returns:

Number:

campaign_id

`getCampaignIdFromCampaignBoardId`

(

i_campaign_board_id

)

Number

Defined in _libs\Pepper.js:1247

Get i_campaign_id into campaign_board_id using local table_campaign_boards (not global boards)

Parameters:

i_campaign_board_id Number

Returns:

Number:

campaign_id

`getCampaignIDs`

() Array

Defined in _libs\Pepper.js:2276

Get a list of all campaigns per the account

Returns:

Array:

campaigns

`getCampaignPlayModeFromTimeline`

(

i_campaign_timeline_id

)

Number

Defined in _libs\Pepper.js:1234

get a Campaign's play mode (sceduler / sequencer) from timeline id

Parameters:

i_campaign_timeline_id Number

Returns:

Number:

play mode

`getCampaignRecord`

(

i_campaign_id

)

Object

Defined in _libs\Pepper.js:2290

Get a campaign table record for the specified i_campaign_id.

Parameters:

i_campaign_id Number

Returns:

Object:

foundCampaignRecord

`getCampaignsSchedules`

(

i_campaign_timeline_id

)

Object

Defined in _libs\Pepper.js:1641

Get campaign schedule for timeline

Parameters:

i_campaign_timeline_id Number

Returns:

Object:

schedule record

`getCampaignTimelineChannelPlayerRecord`

(

i_player_id

)

Object

Defined in _libs\Pepper.js:2743

Get a player_id record from msdb by player_id primary key.

Parameters:

i_player_id Number

Returns:

Object:

player record

`getCampaignTimelineChannelRecord`

(

i_channel_id

)

Object

Defined in _libs\Pepper.js:2770

Get a channel_id record from table channels msdb by channel_id

Parameters:

i_channel_id Number

Returns:

Object:

channel record

`getCampaignTimelineIdOfSequencerIndex`

(

i_campaign_id
i_sequence_index

)

Number

Defined in _libs\Pepper.js:1765

Get the timeline id of the specific sequencer index offset (0 based) under the specified campaign

Parameters:

i_campaign_id Number
i_sequence_index Number

Returns:

Number:

timeline_id

`getCampaignTimelineRecord`

(

i_campaign_timeline_id

)

Object

Defined in _libs\Pepper.js:2797

Get a timeline record from msdb using i_campaign_timeline_id primary key.

Parameters:

i_campaign_timeline_id Number

Returns:

Object:

player record

`getCampaignTimelines`

(

i_campaign_id

)

Array

Defined in _libs\Pepper.js:2808

Get all timeline ids for specified campaign

Parameters:

i_campaign_id Number

Returns:

Array:

timeline ids

`getCampaignTimelineSequencerIndex`

(

i_campaign_timeline_id

)

Number

Defined in _libs\Pepper.js:1784

Get the sequence index of a timeline in the specified campaign

Parameters:

i_campaign_timeline_id Number

Returns:

Number:

sequenceIndex

`getChannelBlocksIDs`

(

i_campaign_timeline_chanel_id

)

Array

Defined in _libs\Pepper.js:2666

Get all the block IDs of a particular channel. Push them into an array so they are properly sorted by player offset time.

Parameters:

i_campaign_timeline_chanel_id Number

Returns:

Array:

foundBlocks

`getChannelIdFromCampaignTimelineBoardViewer`

(

i_campaign_timeline_board_viewer_id
i_campaign_timeline_id

)

Object

Defined in _libs\Pepper.js:2887

Use a viewer_id to reverse enumerate over the mapping of viewers to channels via: campaign_timeline_viewer_chanels -> table_campaign_timeline_chanels so we can find the channel assigned to the viewer_id provided.

Parameters:

i_campaign_timeline_board_viewer_id Number
i_campaign_timeline_id Number

Returns:

Object:

recCampaignTimelineViewerChanelsFound

`getChannelsOfTimeline`

(

i_campaign_timeline_id

)

Array

Defined in _libs\Pepper.js:1517

Get all the campaign > timeline > channels ids of a timeline

Parameters:

i_campaign_timeline_id Number

Returns:

Array:

channel ids

`getFirstBoardIDofCampaign`

(

i_campaign_id

)

Number

Defined in _libs\Pepper.js:1188

Get the first board_id (output) that is assigned to the specified campaign_id

Parameters:

i_campaign_id Number

Returns:

Number:

foundBoardID of the board, or -1 if none found

`getGlobalBoardRecFromTemplate`

(

i_campaign_timeline_board_template_id

)

Object

Defined in _libs\Pepper.js:1563

Get a global board record (not the board that assigned to a campaign, but global). Keep in mind that we only give as an argument the campaign > timeline > board > template id, so we have to query it and find out to which global board its pointing so we can grab the correct record for the correct global board.

Parameters:

i_campaign_timeline_board_template_id Number

to reverse map into global board

Returns:

Object:

global board record;

`getGlobalTemplateIdOfTimeline`

(

i_campaign_timeline_id

)

Array

Defined in _libs\Pepper.js:1499

Get all the global board template ids of a timeline

Parameters:

i_campaign_timeline_id Number

Returns:

Array:

foundGlobalBoardTemplatesIDs global board template ids

`getLoader`

() Object

Defined in _libs\Pepper.js:231

Returns a reference to the Pepper loader

Returns:

Object:

reference to loader

`getLocalization`

(

i_command
i_stationId
i_callBack

)

Defined in _libs\Pepper.js:353

Push a command to remote station

Parameters:

i_command String
i_stationId Number
i_callBack Function

`getLocalizationNew`

(

i_command
i_stationId
i_callBack

)

Defined in _libs\Pepper.js:373

Push a command to remote station, this v2 has a fall back and returns null on fails

Parameters:

i_command String
i_stationId Number
i_callBack Function

`getProofOfPlayStats`

(

i_callBack
i_year
i_playerData

)

Number

Defined in _libs\Pepper.js:262

Get proof of play stats report

Parameters:

i_callBack Function
i_year Number
i_playerData Number

Returns:

Number:

i_month clientId.

`getPseudoIdFromSceneId`

(

i_scene_id

)

Number

Defined in _libs\Pepper.js:884

Translate a scene id to its matching pseudo scene id

Parameters:

i_scene_id Number

Returns:

Number:

pseudo id

`getResourceName`

(

i_resource_id

)

Number

Defined in _libs\Pepper.js:1859

Get the name of a resource from the resources table using it's native_id

Parameters:

i_resource_id Number

Returns:

Number:

resourceName

`getResourceNativeID`

(

i_resource_id

)

Number

Defined in _libs\Pepper.js:1845

Get the native resource id from handle

Parameters:

i_resource_id Number

Returns:

Number:

nativeID

`getResourceRecord`

(

i_resource_id

)

Object

Defined in _libs\Pepper.js:1822

Get a resource record via its resource_id.

Parameters:

i_resource_id Number

Returns:

Object:

foundResourceRecord

`getResources`

() Array

Defined in _libs\Pepper.js:1803

Get all none deleted (!=3) resources per current account

Returns:

Array:

all records of all resources in current account

`getResourceType`

(

i_resource_id

)

String

Defined in _libs\Pepper.js:1833

Get the type of a resource (png/jpg...) for specified native_id

Parameters:

i_resource_id Number

Returns:

String:

resourceType

`getSampleList`

(

i_callBack

)

Defined in _libs\Pepper.js:278

Get list of all create account samples, both lite and pro

Parameters:

i_callBack Function

`getSampleList`

(

i_callBack

)

Defined in _libs\Pepper.js:496

Get list of all create account samples, both lite and pro

Parameters:

i_callBack Function

`getSceneDuration`

(

i_scene_id

)

Number

Defined in _libs\Pepper.js:606

get a scene's default length

Parameters:

i_scene_id Number

Returns:

Number:

total seconds

`getSceneMime`

(

i_sceneID

)

Object

Defined in _libs\Pepper.js:690

Returns all scenes

Parameters:

i_sceneID Number

Returns:

Object:

scene names

`getSceneNames`

(

i_playerData

)

Object

Defined in _libs\Pepper.js:670

Returns all scenes

Parameters:

i_playerData Number

Returns:

Object:

scene names

`getScenePlayerdata`

(

i_scene_id

)

Object

Defined in _libs\Pepper.js:1101

Get Scene player data

Parameters:

i_scene_id Number

Returns:

Object:

XML scene player data

`getScenePlayerdataBlock`

(

i_scene_id
i_player_data_id

)

Number

Defined in _libs\Pepper.js:1035

get a scene block playerdata

Parameters:

i_scene_id Number
i_player_data_id Number

Returns:

Number:

i_player_data_id

`getScenePlayerdataDom`

(

i_sceneID

)

Object

Defined in _libs\Pepper.js:1113

Get Scene player data as dom

Parameters:

i_sceneID Number

Returns:

Object:

dom

`getScenePlayerRecord`

(

i_sceneID

)

Object

Defined in _libs\Pepper.js:1090

Get Scene player record from player_data table

Parameters:

i_sceneID Number

Returns:

Object:

XML playerdata

`getScenes`

() Object

Defined in _libs\Pepper.js:1074

Get all Scenes and convert them to dom objects returning a hash of object literals

Returns:

Object:

all scenes as objects

`getStationCampaignID`

(

i_native_station_id

)

Number

Defined in _libs\Pepper.js:2412

Returns the campaign id that a station is bound to

Parameters:

i_native_station_id Number

Returns:

Number:

campaign_id

`getStationCampaignIDs`

() Array

Defined in _libs\Pepper.js:2317

Returns all of the campaign IDs that all stations belonging to account are associated with

Returns:

Array:

array of campaign IDs

`getStationNameAsync`

(

i_stationID
i_callBack

)

Defined in _libs\Pepper.js:2333

Sync to pepper and get station name for station id, callback on server sync return

Parameters:

i_stationID Number
i_callBack Number

`getStationNameSync`

(

i_stationID

)

String

Defined in _libs\Pepper.js:2350

Get station name from msdb (no remote server async)

Parameters:

i_stationID Number

Returns:

String:

stationName

`getStationRecord`

(

i_native_station_id

)

Object

Defined in _libs\Pepper.js:2431

Returns the record for a station id

Parameters:

i_native_station_id Number

Returns:

Object:

recBranchStation

`getStationRecord`

(

i_native_station_id
record

)

Defined in _libs\Pepper.js:2449

Set a station record via object arg into msdb table_branch_stations

Parameters:

i_native_station_id Number
record Object

`getStudioLiteURL`

() String

Defined in _libs\Pepper.js:397

Return the url address of StudioLite

Returns:

String:

url address

`getStudioProURL`

() String

Defined in _libs\Pepper.js:409

Return the url address of StudioPro

Returns:

String:

url address

`getTemplatesOfTimeline`

(

i_campaign_timeline_id

)

Array

Defined in _libs\Pepper.js:1439

Get all the campaign > timeline > board > template ids of a timeline

Parameters:

i_campaign_timeline_id Number

Returns:

Array:

template ids

`getTemplateViewersScreenProps`

(

i_campaign_timeline_id
i_campaign_timeline_board_template_id

)

Object

Defined in _libs\Pepper.js:2826

Build screenProps json object with all viewers and all of their respective attributes for the given timeline_id / template_id

Parameters:

i_campaign_timeline_id Number
i_campaign_timeline_board_template_id Number

Returns:

Object:

screenProps all viewers and all their properties

`getTimelineTotalDuration`

(

i_campaign_timeline_id

)

Number

Defined in _libs\Pepper.js:2560

Get a timeline's duration which is set as the total sum of all blocks within the longest running channel

Parameters:

i_campaign_timeline_id Number

Returns:

Number:

length in seconds

`getTotalDurationOfBlocks`

(

i_blocks

)

Number

Defined in _libs\Pepper.js:2574

Get the total duration in seconds of all given block ids

Parameters:

i_blocks Array

Returns:

Number:

totalChannelLength

`getUserData`

() Object

Defined in _libs\Pepper.js:210

Return all authenticated user data

Returns:

Object:

reference to all user data

`ieFixEscaped`

(

escapedHTML

)

String

Defined in _libs\Pepper.js:752

"Good" old IE, always a headache, jQuery workarounds....

Parameters:

escapedHTML String

Returns:

String:

`injectPseudoScenePlayersIDs`

(

i_scene_id

)

Defined in _libs\Pepper.js:920

Inject unique player ids for all players within a scene

Parameters:

i_scene_id Number

`livePreviewCampaign`

(

i_campaignID
i_bannerMode

)

String

Defined in _libs\Pepper.js:555

Create a live preview URL for campaign

Parameters:

i_campaignID Number
i_bannerMode Number

Returns:

String:

url

`livePreviewScene`

(

i_scene_id
i_bannerMode

)

String

Defined in _libs\Pepper.js:590

Create a live preview URL for a scene

Parameters:

i_scene_id Number
i_bannerMode Number

Returns:

String:

url

`livePreviewTimeline`

(

i_campaignID
i_timelineID
i_bannerMode

)

String

Defined in _libs\Pepper.js:571

Create a live preview URL for campaign

Parameters:

i_campaignID Number
i_timelineID Number
i_bannerMode Number

Returns:

String:

url

`populateBoardTemplate`

(

i_campaign_timeline_board_template_id

)

Defined in _libs\Pepper.js:2979

Sample function to demonstrate how to enumerate over records to query related tables of a campaign

Parameters:

i_campaign_timeline_board_template_id Number

Returns:

none

`populateBoardTemplate`

(

i_campaign_timeline_board_template_id

)

Defined in _libs\Pepper.js:2940

Sample function to demonstrate how to enumerate over records to query for specified template_id

Parameters:

i_campaign_timeline_board_template_id Number

Returns:

none

`removeAllBoards`

()

Defined in _libs\Pepper.js:1914

Remove all boards in msdb

Returns:

none

`removeAllScenePlayersWithResource`

(

i_resource_id

)

Defined in _libs\Pepper.js:990

Remove all scene players that use resources (3100 & 3130) and that include the specified resource id

Parameters:

i_resource_id Number

`removeBlockFromTimelineChannel`

(

i_block_id

)

Defined in _libs\Pepper.js:1927

Remove a block (i.e.: player) from campaign > timeline > channel

Parameters:

i_block_id Number

Returns:

none

`removeBlocksFromTimelineChannel`

(

i_block_id

)

Defined in _libs\Pepper.js:1939

Remove all blocks (i.e.: players) from campaign > timeline > channel

Parameters:

i_block_id Number

Returns:

none

`removeBlocksWithResourceID`

(

i_resource_id

)

Defined in _libs\Pepper.js:2073

Remove blocks (a.k.a players) from all campaign that use the specified resource_id (native id)

Parameters:

i_resource_id Number

Returns:

none

`removeBlocksWithSceneID`

(

i_scene_id

)

Defined in _libs\Pepper.js:2098

Remove blocks (a.k.a players) from all campaign timeline channels that use the specified scene_id

Parameters:

i_scene_id Number

Returns:

none

`removeBoardTemplate`

(

i_campaign_timeline_board_template_id

)

Defined in _libs\Pepper.js:1984

Remove board template

Parameters:

i_campaign_timeline_board_template_id Number

`removeBoardTemplateFromTimeline`

(

i_timeline_id

)

Number

Defined in _libs\Pepper.js:1971

Remove board template from timeline

Parameters:

i_timeline_id Number

Returns:

Number:

campaign_timeline_board_template_id

`removeBoardTemplateViewer`

(

i_board_template_id
i_board_template_viewer_id

)

Defined in _libs\Pepper.js:2015

Remove board template viewer

Parameters:

i_board_template_id Number
i_board_template_viewer_id Number

`removeBoardTemplateViewers`

(

i_board_template_id

)

Array

Defined in _libs\Pepper.js:1995

Remove board template viewers

Parameters:

i_board_template_id Number

Returns:

Array:

boardTemplateViewerIDs

`removeCampaign`

(

i_campaign_id

)

Defined in _libs\Pepper.js:1887

Remove a campaign record

Parameters:

i_campaign_id Number

Returns:

none

`removeCampaignBoard`

(

i_campaign_id

)

Defined in _libs\Pepper.js:1898

Remove campaign board_id

Parameters:

i_campaign_id Number

Returns:

none

`removeChannelFromTimeline`

(

i_channel_id

)

Boolean

Defined in _libs\Pepper.js:2062

Remove a channel from a timeline

Parameters:

i_channel_id Number

Returns:

Boolean:

status

`removeResource`

(

i_resource_id

)

Defined in _libs\Pepper.js:2265

Remove a timeline from a campaign.

Parameters:

i_resource_id Number

Returns:

none

`removeResourceFromBlockCollectionInScenes`

(

i_resource_id

)

Defined in _libs\Pepper.js:2116

Remove all refernce to a resource id from within Scenes > BlockCollections that refer to that particulat resource id In other words, check all scenes for existing block collections, and if they refer to resource id, remove that entry

Parameters:

i_resource_id Number

resource id to search for and remove in all scenes > BlockCollections

`removeResourceFromBlockCollectionsInChannel`

(

i_resource_id

)

Defined in _libs\Pepper.js:2205

Remove the resource from any block collection which resides in campaign timeline channels that uses that resource in its collection list

Parameters:

i_resource_id Number

Returns:

none

`removeScene`

()

Defined in _libs\Pepper.js:1013

Remove a scene

`removeSceneFromBlockCollectionsInChannels`

(

i_scene_id

)

Defined in _libs\Pepper.js:2174

Remove the scene from any block collection which resides in campaign timeline channels that uses that scene in its collection list

Parameters:

i_scene_id Number

Returns:

none

`removeSceneFromBlockCollectionWithSceneId`

(

i_scene_id

)

Defined in _libs\Pepper.js:2145

Remove all refernce to a scene id from within Scenes > BlockCollections that refer to that particulat scene id In other words, check all scenes for existing block collections, and if they refer to scene_id, remove that entry

Parameters:

i_scene_id Number

scene id to search for and remove in all scenes > BlockCollections

`removeScenePlayer`

(

i_scene_id
i_player_id

)

Defined in _libs\Pepper.js:973

Remove specific player id (i.e.: block) from scene player_data

Parameters:

i_scene_id Number
i_player_id Number

`removeSchedulerFromTime`

(

i_campaign_timeline_id

)

Defined in _libs\Pepper.js:2248

Remove a schedule from timeline

Parameters:

i_campaign_timeline_id Number

Returns:

none

`removeStation`

(

i_station

)

Defined in _libs\Pepper.js:2508

Remove station, delete it from internal msdb and push to server on save

Parameters:

i_station Number

`removeTimelineBoardViewerChannel`

(

i_campaign_timeline_board_template_id

)

Number

Defined in _libs\Pepper.js:2043

Remove the association between the screen division (aka viewer) and all channels that are assigned with that viewer

Parameters:

i_campaign_timeline_board_template_id Number

Returns:

Number:

return the channel that was de-associated with viewer

`removeTimelineBoardViewerChannels`

(

i_campaign_timeline_board_template_id

)

Defined in _libs\Pepper.js:2026

Remove board template viewers

Parameters:

i_campaign_timeline_board_template_id Number

Returns:

none

`removeTimelineFromCampaign`

(

i_campaign_timeline_id

)

Defined in _libs\Pepper.js:2236

Remove a timeline from a campaign.

Parameters:

i_campaign_timeline_id Number

Returns:

none

`removeTimelineFromSequences`

(

i_timeline_id

)

Defined in _libs\Pepper.js:1955

Remove a timeline from sequences

Parameters:

i_timeline_id Number

Returns:

none

`requestData`

(

i_callback

)

Defined in _libs\Pepper.js:252

Sync internal msdb to remote mediaSERVER account

Parameters:

i_callback Function

`restoreScenesWithPlayersIDs`

()

Defined in _libs\Pepper.js:1023

When we remove scene player ids we actually store them aside so we can restore them back after a save as the remote server expects a scene's player_data to have no player ids on its scene player_data

`save`

()

Defined in _libs\Pepper.js:241

Serialize the local msdb and push to remote server

Returns:

none

`sendCommand`

(

i_command
i_stationId
i_callBack

)

Defined in _libs\Pepper.js:290

Push a command to remote station

Parameters:

i_command String
i_stationId Number
i_callBack Function

`sendEvent`

(

i_eventName
i_stationId
i_callBack

)

Defined in _libs\Pepper.js:508

Push an event to remote station

Parameters:

i_eventName String
i_stationId Number
i_callBack Function

`sendLocalEventGPS`

(

i_mode
i_stationId
i_lat
i_lng
i_callBack

)

Defined in _libs\Pepper.js:303

Push an event to a local station / server for Location based content, see parms for details Keep in mind this supports both local and remote events

Parameters:

i_mode String

local or remote
i_stationId Number
i_lat Number
i_lng Number
i_callBack Function

Returns:

{String) short url

`sendSnapshot`

(

i_fileName
i_quality
i_stationId
i_callBack

)

String

Defined in _libs\Pepper.js:520

Send remote command to retrieve snapshot of a running station

Parameters:

i_fileName String
i_quality Number
i_stationId Number
i_callBack Function

Returns:

String:

image path url

`setBlockRecord`

(

i_block_id
i_key
i_value

)

Defined in _libs\Pepper.js:1547

Set a block's record using key value pair The method uses generic key / value fields so it can set any part of the record.

Parameters:

i_block_id Number
i_key String
i_value Number

Returns:

none

`setBlockTimelineChannelBlockLength`

(

i_campaign_timeline_chanel_player_id
i_hours
i_minutes
i_seconds

)

Defined in _libs\Pepper.js:2635

Set a block (a.k.a player) on the timeline_channel to a specified length in total seconds.

Parameters:

i_campaign_timeline_chanel_player_id Number

{string} plyer / block id
i_hours Number

total hours to play
i_minutes Number

total minutes to play
i_seconds Number

total seconds to play

Returns:

none

`setBoardTemplateViewer`

(

i_board_template_viewer_id

)

Number

Defined in _libs\Pepper.js:1458

Set a Board Template Viewer props

Parameters:

i_board_template_viewer_id Number

Returns:

Number:

i_props

`setCampaignRecord`

(

i_campaign_id
i_key
i_value

)

Object

Defined in _libs\Pepper.js:2301

Set a campaign table record for the specified i_campaign_id. The method uses generic key / value fields so it can set any part of the record.

Parameters:

i_campaign_id Number
i_key Object
i_value String

Returns:

Object:

foundCampaignRecord

`setCampaignsSchedule`

(

i_campaign_timeline_id
i_key
i_value

)

Defined in _libs\Pepper.js:1658

Get campaign schedule for timeline

Parameters:

i_campaign_timeline_id Number
i_key Object
i_value Object

`setCampaignTimelineChannelPlayerRecord`

(

i_player_id
i_key
i_value

)

Defined in _libs\Pepper.js:2754

Set a player_id record in msdb on key with value The method uses generic key / value fields so it can set any part of the record.

Parameters:

i_player_id Number
i_key Object
i_value Object

Returns:

none

`setCampaignTimelineChannelRecord`

(

i_channel_id
i_key
i_value

)

Defined in _libs\Pepper.js:2781

Set a channel_id record in channels table using key and value The method uses generic key / value fields so it can set any part of the record.

Parameters:

i_channel_id Number
i_key Number
i_value String

Returns:

none

`setCampaignTimelineRecord`

(

i_player_id
i_key
i_value

)

Defined in _libs\Pepper.js:2871

Set a timeline records in msdb using i_campaign_timeline_id primary key. The method uses generic key / value fields so it can set any part of the record.

Parameters:

i_player_id Number
i_key String

the key to set
i_value Object

the value to set

Returns:

none

`setCampaignTimelineSequencerIndex`

(

i_campaign_id
i_campaign_timeline_id
i_sequenceIndex

)

Defined in _libs\Pepper.js:1677

Set the sequence index of a timeline in campaign. If timeline is not found in sequencer, we insert it with the supplied i_sequenceIndex

Parameters:

i_campaign_id Number
i_campaign_timeline_id Number
i_sequenceIndex Number

is the index to use for the timeline so we can playback the timeline in the specified index order

Returns:

none

`setResourceRecord`

(

i_resource_id
i_key
i_value

)

Object

Defined in _libs\Pepper.js:1871

Set a resource record via its resource_id. The method uses generic key / value fields so it can set any part of the record.

Parameters:

i_resource_id Number
i_key Number
i_value String

Returns:

Object:

foundResourceRecord

`setSceneDuration`

(

i_scene_id
hours
minutes
seconds

)

Defined in _libs\Pepper.js:647

Set a scene's default length (can be overridden on timeline)

Parameters:

i_scene_id Number
hours String
minutes String
seconds String

`setScenePlayerData`

() Number

Defined in _libs\Pepper.js:848

set entire scene playerdata

Returns:

Number:

scene player_data id

`setScenePlayerdataBlock`

(

i_scene_id
i_player_data_id
player_data

)

Defined in _libs\Pepper.js:1053

set a block id inside a scene with new player_data

Parameters:

i_scene_id Number
i_player_data_id Number
player_data XML

`SetStationCampaignID`

(

i_native_station_id
i_campaign_id

)

Defined in _libs\Pepper.js:2468

Set a station so its bound to campaign_id

Parameters:

i_native_station_id Number
i_campaign_id Number

`setStationName`

(

branch_station_id
i_callBack

)

Defined in _libs\Pepper.js:2394

save new station name

Parameters:

branch_station_id Number
i_callBack String

`setStationServerMode`

(

i_native_station_id
i_mode

)

Defined in _libs\Pepper.js:2488

Set a station to server mode enable / disable

Parameters:

i_native_station_id Number
i_mode Boolean

`setTimelineTotalDuration`

(

i_campaign_timeline_id
i_totalDuration

)

Defined in _libs\Pepper.js:2547

Set a timeline's total duration

Parameters:

i_campaign_timeline_id Number
i_totalDuration Number

`sterilizePseudoId`

(

i_id

)

Number

Defined in _libs\Pepper.js:870

Sterilize pseudo id to scene id always returns scene_id as an integer rather pseudo id

Parameters:

i_id Number

Returns:

Number:

i_id

`stripPlayersID`

()

Defined in _libs\Pepper.js:963

Remove all player ids from i_domPlayerData

`stripScenePlayersIDs`

()

Defined in _libs\Pepper.js:944

Remove all player ids from player_data inside a scene

`updateTemplateViewerOrder`

(

i_board_template_viewer_id
i_view_order

)

Defined in _libs\Pepper.js:1373

Change a viewer's (aka screen division) order (layer) z-order

Parameters:

i_board_template_viewer_id Number
i_view_order Number

`uploadResources`

(

i_elementID

)

Array

Defined in _libs\Pepper.js:2524

Upload new resources onto the remote server and return matching ids. The element id is of an HTML id of a multi-part upload element.

Parameters:

i_elementID String

Returns:

Array:

list of resources created from newly attached files or empty array if not valid resource loaded

`xmlToStringIEfix`

(

i_domPlayerData

)

String

Defined in _libs\Pepper.js:740

Returns this model's attributes as...

Parameters:

i_domPlayerData Object

Returns:

String:

xml string

caller This
UNKNOWN Event

digitalsignage.com - open source docs

APIs

Pepper Class

Constructor

Returns:

Item Index

Methods

Events

Methods

_livePreviewGetLink

Parameters:

Returns:

announceTemplateViewerEdited

Parameters:

appendScenePlayerBlock

Parameters:

assignCampaignToBoard

Parameters:

Returns:

assignTemplateToTimeline

Parameters:

Returns:

assignViewersToTimelineChannels

Parameters:

Returns:

assignViewerToTimelineChannel

Parameters:

Returns:

calcTimelineTotalDuration

Parameters:

Returns:

ChangeBusinessName

Parameters:

ChangePassword

Parameters:

checkAndCreateCampaignTimelineScheduler

Parameters:

Returns:

createAccount

Parameters:

createBoard

Parameters:

Returns:

createCampaign

Parameters:

Returns:

createCampaignTimelineScheduler

Parameters:

Returns:

createNewChannelPlayer

Parameters:

Returns:

createNewTemplate

Parameters:

Returns:

createNewTimeline

Parameters:

Returns:

createPseudoSceneID

Parameters:

Returns:

createScene

Returns:

createTimelineChannel

Parameters:

Returns:

createTimelineChannels

Parameters:

Returns:

createViewer

Parameters:

Returns:

dbConnect

Parameters:

Returns:

event

Parameters:

Returns:

formatObjectToSeconds

`Pepper`

`_livePreviewGetLink`

`announceTemplateViewerEdited`

`appendScenePlayerBlock`

`assignCampaignToBoard`

`assignTemplateToTimeline`

`assignViewersToTimelineChannels`

`assignViewerToTimelineChannel`

`calcTimelineTotalDuration`

`ChangeBusinessName`

`ChangePassword`

`checkAndCreateCampaignTimelineScheduler`

`createAccount`

`createBoard`

`createCampaign`

`createCampaignTimelineScheduler`

`createNewChannelPlayer`

`createNewTemplate`

`createNewTimeline`

`createPseudoSceneID`

`createScene`

`createTimelineChannel`

`createTimelineChannels`

`createViewer`

`dbConnect`

`event`

`formatObjectToSeconds`

`formatSecondsToObject`

`generateSceneId`

`getAdPackContNames`

`getAssignedViewerIdFromChannelId`

`getBlockRecord`

`getBlockTimelineChannelBlockLength`

`getBoardFromCampaignBoard`

`getBoardTemplateViewer`

`GetBusinessUserInfo`

`GetBusinessUserInfo`

`GetBusinessUserInfo`

`getCampaignIdFromCampaignBoardId`

`getCampaignIdFromCampaignBoardId`

`getCampaignIDs`

`getCampaignPlayModeFromTimeline`

`getCampaignRecord`

`getCampaignsSchedules`

`getCampaignTimelineChannelPlayerRecord`

`getCampaignTimelineChannelRecord`

`getCampaignTimelineIdOfSequencerIndex`

`getCampaignTimelineRecord`

`getCampaignTimelines`

`getCampaignTimelineSequencerIndex`

`getChannelBlocksIDs`

`getChannelIdFromCampaignTimelineBoardViewer`