Category:APIs
From SpinetiX Support Wiki
Contents
Introduction
This category groups pages about application programming interfaces (APIs) available on SpinetiX players. These pages are meant for developers and usually require a higher level of SVG and JavaScript knowledge.
The APIs available on SpinetiX players are detailed below.
APIs for remote control and monitoring
- RPC API for remote management and monitoring.
- HMP Configuration API for local and remote configuration.
- Pull Mode for remote distribution of content.
- Status API for getting the current status of the player (operating status, device stats, screen display settings, storage details etc.) or snapshot of the content being rendered.
- Web Storage REST API to allow reading and writing variables (i.e. localStorage data) onto the player from external clients through HTTP(S) calls.
- Shared Variables Network API to remotely update shared data or trigger UI events.
JavaScript APIs
See more details about the supported JavaScript APIs.
High level APIs
- jSignage API to simplify writing JavaScript code for animations, interactivity & event handling, DOM traversal & manipulation, Ajax calls, data feed parsing etc.
- jSignage Graph API for generating charts and gauges graphs.
- jSignage QR code API for generating QR code graphics.
- Shared Variables JavaScript API for access to Shared Variables framework for real-time data exchange.
- Web Storage API for permanent storage of structured data on the client side (HMP, Elementi).
Low level APIs
- SVG Tiny 1.2 Micro DOM (uDOM) API for generating SVG content.
- JavaScript COM API for interacting with devices connected to the HMP via the serial port.
- USB I/O API for interacting with USB devices that comply to the HID specification.
- Node.js API for creating UDP and TCP sockets and servers.
- HTMLImageElement API for querying information about the dimensions of graphic resources.
- XMLHttpRequest Level 1 API for transferring data between a client and a server.
- HTML Canvas 2D Context API to draw and manipulate graphics on a canvas drawing surface.
Pages in category "APIs"
The following 118 pages are in this category, out of 118 total.
A
C
G
- JSignage:Graph:Axis styling attributes
- JSignage:Graph:Bar and column charts
- JSignage:Graph:Basic bar and column charts
- JSignage:Graph:Circular gauges
- JSignage:Graph:Gauge styling attributes
- JSignage:Graph:Grouped bar and column charts
- JSignage:Graph:Line and area charts
- JSignage:Graph:Linear gauges
- JSignage:Graph:Percentage bar and column charts
- JSignage:Graph:Pie and donut charts
- JSignage:Graph:Scatter and bubble charts
- JSignage:Graph:Stacked and grouped bar and column charts
- JSignage:Graph:Stacked bar and column charts
- JSignage:Graph:Styling attributes
- JSignage:Group layers
I
J
- JavaScript COM API
- JSignage:JQuery port to the uDom
- JSignage
- JSignage animation events
- JSignage API
- JSignage Astronomy plugin
- JSignage Custom Effects plugin
- JSignage effects
- JSignage Graph plugin
- JSignage Multiscreen plugin
- JSignage QRCode plugin
- JSignage Social plugin
- JSignage timer methods
- JSignage transitions
- JSignage tutorials
- JSignage UI plugin
- JSignage utilities methods
L
M
P
- JSignage:Parsers
- Parsing functions
- JSignage:Path
- JSignage:PingPongTextArea
- Player APIs
- JSignage:Playlist
- JSignage:PlaylistTutorial1
- JSignage:PlaylistTutorial2
- JSignage:PlaylistTutorial3
- JSignage:PlaylistTutorial4
- JSignage:PlaylistTutorial5
- JSignage:PlaylistTutorial6
- JSignage:Polygon
- JSignage:Polyline
- JSignage:Popup
- JSignage:ProgressBar
- Pull Mode
- JSignage:PushButton
R
S
T
- JSignage:Table
- JSignage:TableTutorial1
- JSignage:TableTutorial2
- JSignage:TableTutorial3
- JSignage:Text layers
- JSignage:TextArea
- JSignage:TextTutorial1
- JSignage:TextTutorial2
- JSignage:TextTutorial3
- JSignage:TextTutorial4
- JSignage:TextTutorial5
- JSignage:TextTutorial6
- JSignage:TextTutorial7
- JSignage:TextTutorial8