Enable spot communication

Prev Next

Spot-to-spot communication lets spots in different splits on different players communicate with each other, for example, to synchronize their contents.

Send a message to another spot

Sends a spot-to-spot message to another player or split.

Parameters

function(ip, uniqueID, value)

ip is the IP of the player to which the message is sent.

uniqueID is for differentiating between various messages.

value is the message as a string. The string can also contain XML or JSON data. The sender and receiver spot must use the same structure.

Examples

GFSpotBase.sendSpotToSpotMessage("127.0.0.1","ProductSelectedEvent","<product><id>243</id><name>Some Product Name</name></product>");

GFSpotBase.sendSpotToSpotMessage("192.168.0.50","NewsDisplayCurrentPageEvent","3");

Players

Windows Player version 7.7 or lat

Linux Player version 10.1 or later

Receive a message from another spot

To receive spot-to-spot messages in the HTML application, the reception method must be overwritten and the player must be know that the spot is for spot-to-spot messages.

Use the init() method after the <body onload="init()">:

function init() {
  // Override the receiver function
  GFSpotBase.receiveSpotToSpotMessage = function (uniqueID, value) {
    // do something
  };

  // Tell the player that you are ready to receive spot to spot messages
  GFSpotBase.readyForSpotToSpotMessage();
}

Send an email via the player

Sends an email via the player.

Parameters

function(headerText, bodyTextLines, email)

headerText is the subject of the email.

bodyTextLines is an array of lines for the body.

email specifies the address if @ is included. Otherwise, the value is written in the body and the email is sent to the email address specified in the player config file.

Examples

GFSpotBase.sendEmail("Some subject", ["Some body"], "example@domain.com");

Player

Windows from global Version 7.7

Windows/Linux from player version 10.1

Note

  • You must configure and activate this function on the player.

  • Separate all values that are transferred to the player using: '_|_'

  • Don’t use this separator in the parameter values.