API V1

This is the old Api for PlayoutBee up to version 0.9.5 please check API v2 if want to see the latest

Play

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

This endpoint will send the Play Command

Pause

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

Stop

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

Select Clip

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

Select's the

Path Parameters

NameTypeDescription

ID

integer

0 Based id of the Clip to select

Set Loop

POST http://playoutbee:3000/api/loop/{state}

Path Parameters

NameTypeDescription

state

string

either on or off

Next

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

goes to the next Clip

Get Clips

GET http://playoutbee:3000/api/clips

returns a list of all Clips

[{"name":"Name of file","uri":"location of the file","length":"00:00:09:06},
{"name":"Name of file","uri":"location of the file","length":"00:00:09:06}]

Get Player

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

Get's the Player Object

Path Parameters

NameTypeDescription

string

{"clipID":0,
"status":"stopped",
"loop":false,
"timecode":"00:00:00:00",
"remainingtimecode":9.24,
"preview":false,
"clips":[List of Clips]}

Get Current Clip

GET http://playoutbee:3000/api/currentClip

Gets the current Player Object

{"name":"Nameofclip.mp4","uri":"location of Clip","length":"00:00:09:06"}

upload Video

POST http://playoutbee:3000/upload

uploads a Video and adds it to the playlist

Request Body

NameTypeDescription

file

object

the file to Upload

Last updated