Player APIs Overview
The SpinetiX player exposes multiple APIs for remote control, monitoring, and content scripting.
APIs for Remote Control & Monitoring
RPC API
Purpose: Remote management and monitoring via JSON-RPC
over HTTP.
Endpoint: POST http://[player_address]/rpc
Key methods: webstorage_set, get_info, restart, firmware_update
Status API
Purpose: Get current player status (operating status,
device stats, screen settings, storage).
Endpoint: GET http(s)://[player_address]/status/info
Authentication: HTTP Basic with "monitoring" or "admin"
rights.
Returns XML with sections: <device>, <status>, <stats>, <fileErrors>, <time>, <network>, <screen>, <storage>
📖 Status API on SpinetiX Wiki →
See also: Web Storage & Status API for full details and code examples.
Web Storage REST API
Purpose: Read/write localStorage variables
via HTTP(S) calls.
Added in: firmware 4.3.0.
Shared Variables Network API
Purpose: Remotely update Shared Variables or trigger UI events. Must be enabled in Control Center (disabled by default).
See: Shared Variables
Configuration API & Pull Mode
Configuration API: Local and remote player
configuration. Wiki →
Pull Mode: Remote distribution — player pulls content
from a server. Wiki →
High-Level JavaScript APIs
| API | Purpose | Details |
|---|---|---|
| jSignage | jQuery-like library for SVG uDOM | jSignage Core |
| Graph plugin | Charts and gauges | Plugins |
| QR Code | Generate QR code graphics | Plugins |
| Shared Variables JS | Real-time data exchange | Shared Variables |
| Web Storage JS | Permanent key-value storage | Web Storage |
Low-Level APIs
| API | Purpose |
|---|---|
| SVG Tiny 1.2 uDOM | Native SVG content generation |
| JavaScript COM API | RS-232 serial port interaction |
| USB I/O API | USB HID device interaction |
| Node.js API | UDP/TCP sockets and servers (v7.x) |
| HTMLImageElement | Query image dimensions |
| Canvas 2D Context | Draw/manipulate graphics on canvas |
Related Pages
- jSignage Core — loading the library, SpiderMonkey 17 constraints
- Layers Overview — all 30+ layer types
- Data Feeds & AJAX — fetching external data
- Utilities & Timers — helper functions