Player APIs

From SpinetiX Support Wiki

Jump to: navigation, search

Introduction

In computer programming, an application programming interface (API) is a set of subroutine definitions, communication protocols and tools for building software. In general terms, it is a set of clearly defined methods of communication among various components. A good API makes it easier to develop a computer program by providing all the building blocks, which are then put together by the programmer.

Just as a graphical user interface (GUI) makes it easier for people to use programs, application programming interfaces make it easier for developers to use certain technologies in building applications. An API simplifies programming by abstracting the underlying implementation and only exposing objects or actions the developer needs.

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

Low level APIs

This page was last modified on 7 February 2019, at 13:42.