Overview

The platform allows for external control of its functionality via documented open interface (API):

• Addreality Manager API;
• Command line API;
• ActionScript 3.0 API.

The Addreality Manager API enables you to interact with advertisement campaigns, content, and status of the media display points. To access the API, copy the link found in the Addreality Manager, on the "Devices" page, upon clicking the API button.

Using the Command line API enables to you to manage the project script through console command, e.g.:

• switch to the specified component of the script;
• initialize use of P2P message transfer mechanism;
• send message to all devices within group (broadcast);
• send message to the log keeping system and the Personal Profile;
• change the video output status (on/off).

To activate the Command line API:

1. In Addreality Designer, open the project template setting ("Project settings" in the "Project" menu).
2. In the API section check the "Command line API" box.
3. Click "OK" to save project settings.
4. Command line API will be activated.

ActionScript 3.0 API enables execution of the following commands and data requests:

• work with variables "Switchover records array", "Unique component ID", "Path to project files", "Statistic reporting on", "Session data storage parameters", "XML representation of module data (if available)";
• initiate switchover to a module with corresponding switchover record;
• switchover to component by ID;
• switchover to the starting component;
• request for closing the current component;
• get switchover record by sequential number;
• check for switchover record with specified name;
• module readiness notification (initialization and upload of elements is finished);
• clear browser cash;
• clear cookies;
• show onscreen keyboard;
• hide onscreen keyboard;
• import media file;
• export media file;
• import file with text data;
• make a content show record;
• finalize (and sent) a content show record;
• set value of a form’s variable;
• get value of a form’s variable;
• set byte array of a form’s variable;
• clear form;
• send form;
• prepare a p2p mechanism for message transfer between players;
• send a p2p message to a group;
• send log;
• change display (video output) state (on/off);
• turn off or reload media display device;
• restart player;
• rectangle defining the visible display area;
• component GUID;
• whether settings must be saved;
• preload type;
• background mode;
• unique project ID;
• media display point name;
• project name;
• OS type;
• current user interface language;
• component title;
• display zone (rectangle);
• display zone tilt.