Documentation
Guides for setting up and running a party from your own files, and the reference for anyone writing a source of music for Let’s DJ.
Guides
For people who are not developers: installing the app, choosing a folder, and two worked examples.
- Setting up the BridgeShare a folder of music, video, and karaoke files from your computer: download, open, choose a folder, connect.
- Worked example: a karaoke nightA folder of karaoke videos named Artist - Title, artwork beside each, and the formats the screen will refuse.
- Worked example: sharing music and videoA mixed folder of songs and videos, audio-only tracks, and what the room sees while one plays.
Provider protocol
The specification a program follows to give Let’s DJ its songs. It is written to stand on its own: it assumes you have never seen our code, and you do not need to.
- The provider protocolWhat a provider is, how the catalogue and the media travel, and the words this specification uses.
- Connecting a providerHow a provider gets its sync token: a code, a page the owner approves, and a token delivered once.
- Sending a catalogueThe sync request, artwork, and how a library is replaced or added to.
- Serving mediaThe media route, range requests, CORS, and which formats a browser will open.
- CapabilitiesWhat a provider declares about itself, and what each flag means when it is absent.
- Answering on demandSearch, preview, and fetch as jobs a provider collects, reports on, and completes.
- A name and a certificateThe two pieces of infrastructure we host, what they accept, and what we will not do.
- Cloud storage, and why not just S3How we catalogue an S3-compatible bucket, and why a provider is not simply an S3 endpoint.