👨‍💻API

the Api Documentation for PlayoutBee

Since PlayoutBee is still in Beta, this API is still subject to change, but the main functions should be stable

The PlayoutBee API is split into these categories:

Transport Functions

Asset Functions

Info Functions

RaspberryPI Specific API

Windows & MacOS API

Transport Functions

Play

POST http://playoutbee:3000/api/play

This endpoint will send the Play Command.

200

 e

Pause

POST http://playoutbee:3000/api/pause

200

Stop

POST http://playoutbee:3000/api/stop

200

goes to the next Clip

POST http://playoutbee:3000/api/next

200

goes to the previous Asset

POST http://playoutbee:3000/api/prev

Select Clip

POST http://playoutbee:3000/api/select/{Index}

Select's the Current Clip by Index

Path Parameters

Name	Type	Description
Index	integer	0 Based index of the Asset to select

200

Goto specifc timestamp

POST http://playoutbee:3000/api/goto/{ms}

Path Parameters

Name	Type	Description
ms*	String	Timestamp to go to in ms or leading with a [+/-] for incremental changes

200: OK

Goto last X Seconds

POST http://playoutbee:3000/api/last/{ms}

Path Parameters

Name	Type	Description
ms*	float	seconds to go before the end of an asset

200: OK

Asset Functions

All Asset commands also accept "next", "prev" or "current" as Index

Upload Asset

POST http://playoutbee:3000/upload

uploads an Asset and adds it to the playlist

Request Body

Name	Type	Description
files	object	an Array of files that should be uploaded

200

Selects the Asset

POST http://playoutbee:3000/api/asset/{Index}/select

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Enables the Asset and puts it into the rotation

POST http://playoutbee:3000/api/asset/{Index}/enable

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Disable the Asset and removes it from the rotation

POST http://playoutbee:3000/api/asset/{Index}/disable

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Set the Volume of the Asset

POST http://playoutbee:3000/api/asset/{Index}/volume/{volume}

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"
volume	String	Volume of the Asset either a float between 0 and 1 or a float between 0 and 1 with a [+/-] sign infront for incremental changes

200: OK

Set the Action of the Asset

POST http://playoutbee:3000/api/asset/{Index}/action/{action}

set's the Action for the Asset

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"
action	String	0 = Pause 1 = PlayNext 2 = Next 3 = Loop 4 = Reset

200: OK

Set the Rotation of the Asset

POST http://playoutbee:3000/api/asset/{Index}/rotate/{rotation}

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"
rotation	String	One of these : 0 90 180 270

200: OK

Sets the InPoint to the current timestamp

POST http://playoutbee:3000/api/asset/current/inPoint

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Sets the OutPoint to the current timestamp

POST http://playoutbee:3000/api/asset/current/outPoint

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Resets the Inpoint of the current Asset

POST http://playoutbee:3000/api/asset/current/resetinPoint

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Resets the Outpoint of the current Asset

POST http://playoutbee:3000/api/asset/current/resetOutPoint

Path Parameters

Name	Type	Description
Index*	String	Index of the Asset or "next", "prev", "current"

200: OK

Info Functions

get all of the Assets

GET http://playoutbee:3000/api/assets

200: OK as example : "1.10.0"

get the current Player State

GET http://playoutbee:3000/api/player

200: OK as example : "1.10.0"

get the current Player State

GET http://playoutbee:3000/api/settings

200: OK as example : "1.10.0"

the current Version of Playoutbee

GET http://playoutbee:3000/api/version

200: OK as example : "1.10.0"

responds with Pong to the response

GET http://playoutbee:3000/api/ping

200: OK "pong"

the currentTime of the Asset

GET http://playoutbee:3000/api/currentTime

200: OK float as example "4.24"

RaspberryPI Specific API

opens the Chrome Browser for PlayoutBee to Output on the Pi

GET http://playoutbee:3000/api/openOutput

200: OK float as example "4.24"

Shutsdown the RaspberryPi

GET http://playoutbee:3000/api/shutdown

200: OK float as example "4.24"

Windows & MacOS API

Move Output to Screen

GET http://playoutbee:3000/api/moveOutput/{id}

Query Parameters

Name	Type	Description
*	String	Index of the Screen the Output should be sent to

200: OK float as example "4.24"

Fullscreen Output

GET http://playoutbee:3000/api/fullscreenOutput

200: OK float as example "4.24"

Toggle the Frame around the Output

GET http://playoutbee:3000/api/toggleFrame

200: OK float as example "4.24"

Enable Frame around the Output

GET http://playoutbee:3000/api/enableFrame

200: OK float as example "4.24"

Disable the Frame around the Output

GET http://playoutbee:3000/api/disableFrame

200: OK float as example "4.24"

Toggle the Output always beeing on Top

GET http://playoutbee:3000/api/alwaysOnTop

200: OK float as example "4.24"

Toggle the Prevent Sleep Setting

GET http://playoutbee:3000/api/preventSleep

200: OK float as example "4.24"

Opens the OutputWindow if it isn't Open already

GET http://playoutbee:3000/api/openOutput

200: OK float as example "4.24"

Moves the Output window to x / y and resizes it to W and H

GET http://playoutbee:3000/api/moveOutput/{x}/{y}/{w}/{y}

Path Parameters

Name	Type	Description
x	String	X in Pixels for the Output Window
y	String	Y in Pixels for the Output Window
w	String	Width of the Output Window
h	String	Height of the Output Window

200: OK float as example "4.24"