This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Overlay- und Config-API

Alle Admin-Endpunkte benötigen den bestehenden Bearer-Token.

Overlay-Katalog und Instanzen

Methode	Endpoint	Zweck
GET	/api/overlay-types	Overlay- und Modul-Contributions samt Defaults und JSON Schemas
GET	/api/overlays	Alle Instanzen einschließlich Config, Modulen und Revision
POST	/api/overlays	Neue Instanz aus name, source, typeId, config, modules
POST	/api/overlays/:id/enabled	Instanz aktivieren/deaktivieren
DELETE	/api/overlays/:id	Instanz löschen

Revisionierte Config

Methode	Endpoint	Zweck
GET	/api/overlays/:id/config	{ config, modules, revision } lesen
PUT	/api/overlays/:id/config	Dokument vollständig ersetzen
PATCH	/api/overlays/:id/config	RFC-7396-JSON-Merge-Patch anwenden

PUT-Beispiel:

{
  "config": { "fontSize": 24 },
  "modules": [{
    "id": "my-extension#brand-frame",
    "enabled": true,
    "layer": 10,
    "config": { "color": "#9146ff" }
  }],
  "revision": 3
}

Ein erfolgreicher Schreibzugriff erhöht die Revision. Eine veraltete Revision liefert 409 Conflict. Schemafehler liefern 400 mit Feld und Begründung. Änderungen erreichen laufende Browser-Sources über configChanged-Control-Frames.

Der alte POST-Config-Endpunkt bleibt kompatibel, validiert aber ebenfalls und erhöht die Revision.

Queue-Verwaltung

Methode	Endpoint	Zweck
GET	/api/event-queue	Aktueller Event, Deliveries, Deadlines, wartende Events und Zähler
POST	/api/event-queue/current/ack	Alle offenen Deliveries des aktuellen Events freigeben
POST	/api/event-queue/:eventId/discard	Einen wartenden Event verwerfen

Die Admin-UI aktualisiert die Ansicht sekündlich. Sie zeigt offene/bestätigte Listener, ältesten Event, Queue-Länge und Skip-Zähler. Umsortieren ist absichtlich nicht vorgesehen.

Öffentliche Overlay-Routen

• /overlay/:id/ – OBS-Browser-Source
• /overlay/:id/config.json – validierter Runtime-Config-Stand
• /overlay/:id/entry.js – aktiver Overlay-Typ
• /overlay/:id/modules/:module/entry.js – aktives Modul
• /overlay/:id/modules/:module/assets/* – geprüfte Modul-Assets
• /ws/overlay/:id – Queue- und Control-Protokoll