👨‍💻API

the Api Documentation for PlayoutBee

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.

 e

Pause

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

Stop

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

goes to the next Clip

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

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

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

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

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

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"

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"

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"

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

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

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

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"

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"

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"

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"

Info Functions

get all of the Assets

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

get the current Player State

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

get the current Player State

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

the current Version of Playoutbee

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

responds with Pong to the response

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

the currentTime of the Asset

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

RaspberryPI Specific API

opens the Chrome Browser for PlayoutBee to Output on the Pi

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

Shutsdown the RaspberryPi

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

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

Fullscreen Output

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

Toggle the Frame around the Output

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

Enable Frame around the Output

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

Disable the Frame around the Output

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

Toggle the Output always beeing on Top

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

Toggle the Prevent Sleep Setting

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

Opens the OutputWindow if it isn't Open already

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

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

Last updated

Was this helpful?