Direct play: For developers
How Direct play is built, for anyone who wants to change it or make one like it. It is MIT, by TheMightyTRexUK, and works with plug-in API >=1.14 <2.0.
Its files
starboard-plugin.jsonapp.pysbplugin.pyDockerfileinstall.pylogo.svgHELP.mdCHANGELOG.mdtests/test_direct_play.py
Containers
| Container | Network | Folders | Runs as | Starts | Limits |
|---|---|---|---|---|---|
main |
lan |
data, media/movies, media/tv |
media |
always |
512 MB, 1 core |
Each image is pinned by digest in the manifest:
main:ghcr.io/themightytrex/starboard-plugin-direct-play@sha256:5f98e9a8583c7cfaf909f939047777adccc235792ed67b9c7961bc33ca418830
What Starboard calls
| Path | What it is |
|---|---|
GET /health |
Health: 200 while it can work |
GET /card |
The Direct play card (list) |
GET /summary |
The Space saved by Direct play card (stat) |
POST /pause |
The Pause fixing button |
POST /resume |
The Resume fixing button |
POST /survey |
The Check the library now button |
GET /files |
The Files page |
POST /jobs/quiet |
The job Direct play in quiet hours |
POST /update/before |
The update's before step, 60 seconds at most |
POST /update/after |
The update's after step, 10 seconds at most |
Jobs
quiet: every 1 hour, only in quiet hours, 1 minutes at most.
How it works
- A worker wakes once a minute and does nothing outside the hours set in When it works. In its hours it reads the movies and tv folders with ffprobe, at most every 6 hours, reading only new or changed files, then fixes one file at a time, cheapest fix first.
- ffmpeg runs with
niceandioniceat the lowest priority, with two threads. Each new file is checked before it replaces the original, then Reelix rescans the film or series and Jellyfin is told the file changed. - Starboard's quiet-hours job (
POST /jobs/quiet) wakes it each hour in Starboard's quiet hours. - The cards read a small status file the worker writes, at most as often as Card updates every says, so nothing is probed for a card. The Direct play card sends
converting,waiting,paused,doneorneeds_setup. - Before an update it stops the file being converted and removes its unfinished copy, and after the update it carries on.
- It runs as the owner of your media folder (
user: media), so the new files are yours.
Find out more
This page on GitHub, where the help is written.