Socket API

The Socket API allows you to connect to an instance of PlayoutONE and request various information.

To enable simply go to Settings>Splits and enable the Socket API and either set the desired port or leave it as the default.

Note: This port setting takes effect across all instances of PlayoutONE connected to the same database.

Sending Requests

To send a request you have to connect to the machines IP via the port you have set. The API is setup to use a TCP stream. You can either connect, then drop the connection when you have received your information, or you can stay connected.

Commands

All multiple value responses have their values separated by ASCII Chr(1) to make it easier to split this data up once received.

Command	Description	Returns
`GET CURRENT PLAYER`	Get the current playing player.	Base zero result, i.e. Player 1 on the screen will be 0 in the response. Player 2 on screen will be 1 in the response and so on.
`GET CURRENT PLAYER POSITION` or `GET CURRENT PLAYER POSITION_MS`	Get the current playing player position in milliseconds.	Current player (base zero) Current Position Title Artist
`GET CURRENT PLAYER POSITION_TIME`	Get the current playing player position in human time hh:mm:ss	Current player (base zero) Current Position Title Artist
`GET CURRENT PLAYER PROGRESS` or `GET CURRENT PLAYER PROGRESS_MS`	Get the current playing players progress in milliseconds.	Current player (base zero) Trim In Intro Hook In Hook Out Extro Trim Out Current Position Title Artist
`GET CURRENT PLAYER PROGRESS_TIME`	Get the current playing players progress in human time hh:mm:ss	Current player (base zero) Trim In Intro Hook In Hook Out Extro Trim Out Current Position Title Artist
`GET CURRENT PLAYER TITLE`	Get the title of the current playing player	Current player (base zero) Title
`GET CURRENT PLAYER ARTIST`	Get the artist of the current playing player	Current player (base zero) Artist
`GET CURRENT PLAYER NOW_PLAYING`	Get the title and artist of the current playing player	Current player (base zero) Title Artist

Note: You can also send any of the other commands listed here.