easyvis Player API API Reference

Welcome to the easyvis Player API. This API enables you to easily manage and control your visualization devices (like TV, LED walls, laser) and provide your dedicated digital content to your devices. It makes it easy for you to connect your digital solutions with your visualization devices.

API Endpoint https://api.easyvis.io/v1

easyvis distinguishes between players and devices. In easyvis the player is located in the cloud and abstracts the usual player functionality (like play and stop) from the actual device.
Once you have registered and configured a real visualization device with easyvis you can connect it to a player.
So it is like in the real world with DVD/Blueray/Video players that the player is connected to a device which is visualizing something but for easyvis the player is located in the cloud.

After the initial setup of your devices and players you can start controlling your players by providing video streams, text, colors and more to be played/displayed on the device connected to your player. It is like a digital cloud remote control and you decide via this API what should be shown. Have fun!

All requests are authenticated using oauth. For more information see http://developer.easyvis.io/docs/basics/authorization/

Contact: info@easyvis.io

Version: 0.6.3

Paths

Player

Lists all players

GET /players/

Returns a list of all your players.

200 OK

player

Successful operation which returns all players of the user

type

player

Response Example (200 OK)

[
  {
    "playerName": "MyPlayer",
    "devices": [
      "MyDevice1"
    ]
  }
]

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string


oauth	easyvis.io.player/players
APIKeyHeader

Player

Get player

GET /players/{playerId}/

Retrieves information on a player (e.g. state of player)

playerId: object

in path

Defines the player name

200 OK

playerStates

Player information retrieved successfully

type

playerStates

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string


oauth	easyvis.io.player/players
APIKeyHeader

Player

Control player - Play

POST /players/{playerId}/play

This is your remote control method for your player which enables you to play your visualization apps (e.g. video streams) to display digital content on your device.

Array of player actions as visualization apps

visualizationApp

playerId: object

in path

Defines the name of the player to be controlled

Request Example

[
  {
    "type": "string",
    "config": "object",
    "playConfig": {
      "loop": "integer"
    }
  }
]

200 OK

playerStates

Player action executed

type

playerStates

202 Accepted

Player action forwarded to device but confimation from device for successful playback start

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Headers (202 Accepted)


Access-Control-Allow-Origin	undefined	string


oauth	easyvis.io.player/playback
APIKeyHeader

Player

Control player - Stop

POST /players/{playerId}/stop

This is your remote control method for your player to stop the current playback.

playerId: object

in path

Defines the name of the player to be controlled

200 OK

Player action executed

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string


oauth	easyvis.io.player/playback
APIKeyHeader

Schema Definitions

visualizationApp: object

A detailed description of the different visualization apps can be found on the developer page http://developer.easyvis.io/docs/visualization-apps/

type: string STREAM, IMAGE, CLOCK, TEXT, PROGRESS, BLINK, PULSE, TWINKLE, SHAPE, WEBSITE: Defines the type of the visualization app
config: object: Configuration of the visualization app to be played.
playConfig: object: Configuration of the playback
loop: integer Defines the loop configuration of the playback. -1 is infinite, a positive number defines the number of repetitions. Default is 0 (no loop).

Example

{
  "type": "string",
  "config": "object",
  "playConfig": {
    "loop": "integer"
  }
}

player: object

playerId: string: The name of the player
devices: array: The set of linked devices to this player

Example

{
  "playerName": "MyPlayer",
  "devices": [
    "MyDevice1"
  ]
}

playerStates: object

connectionStatus: deviceStatus
state: object[]
object id: string Identifier of a playback mediaConfig: object Configuration of the media used for the playback mediaType: string Media type used (e.g. STATIC_COLOR) playConfig: object Playback configuration (e.g. outputs used for playback) startTime: string Start time of playback (as UNIX timestamp)

Example

{
  "state": [
    {
      "id": "string",
      "mediaConfig": "object",
      "mediaType": "string",
      "playConfig": "object",
      "startTime": "string"
    }
  ]
}

Documentation by Spectacle