Backend API for Frontend

[TurtleTony]

Backend-Api Calls

Create

/create/*

Create title(s)

POST /new/titles

{
    "url": "<url>"
}

success: 202

{
    "request_id": "<request_id>" 
}

too man requests: 429

Instances

/instances/*

Instances update

POST /instances/update

{
   "instance_id": "<instance_id>"
}

always: 204

POST /instances/start

{
    "instance_id": "<instance_id>"
}

success: 202

already running: 405

Play

/playback/*

Play playlist

POST /playback/playlist

{
    "instance_id": "<instance_id>",
    "playlist_id": "<playlist_id>",
    "title_id":"<title_id>" (optional, start with this title if specified)
}

always: 204

Enqueue

POST /playback/enqueue

{
    "instance_id": "<instance_id>",
    "title_id": ["<title_id>"]
}

success: 204

Set shuffle

POST /playback/shuffle

{
    "instance_id": "<instance_id>",
    "shuffle": true|false
}

success: 204 invalid, as not in playlist: 405

Set repeat

POST /playback/repeat

{
    "instance_id": "<instance_id>",
    "repeat": true|false
}

success: 204 invalid, as not in playlist: 405

Pause

POST /playback/pause

{
    "instance_id": "<instance_id>",
}

success: 204 invalid, as nothing to pause: 405

Resume

POST /playback/pause

{
    "instance_id": "<instance_id>",
}

always: 204 invalid, as no instance to resume: 405

[TurtleTony]

This should be in a somewhat final state for now

[0xpr03]

Missing:

• Instance edit (minors: name change etc, doesn't require restart)
• Instance edit: major: requires restart
• Instance stop/start
• Instance status

[0xpr03]

Updated, added pause,resume Changed some requests to fallible /play/ => /playback/ Missing:

• Title added/removed from queue
• Title added/removed from playlist

[0xpr03]

Closing as the new architecture removes this API.