Callaba
Callaba-Startseite

Multiview

Multiview überwacht RTSP-, SRT-, RTMP- und NDI-Eingaben in einem browserbasierten Board. RTSP-Kameras und Media-Server-URLs lassen sich direkt hinzufügen; eine SRT- oder RTMP-Konvertierungsstufe ist nicht allein für ihre Anzeige erforderlich.

Ein Board erstellen und aktualisieren

Verwenden Sie x-access-token für Verwaltung und authentifizierte Viewer-Sitzungen. create speichert Layout, Sichtbarkeit und erste Eingaben; eine leere Liste ist zulässig. update übernimmt die vollständige gewünschte Eingabeliste und das Layout, daher werden ausgelassene Eingaben getrennt. Lesen Sie das aktuelle Objekt, bevor Sie eine nicht leere Liste ersetzen.

Starten, beitreten und prüfen

start und stop steuern die Monitoring-Laufzeit. getAll, getCount und getById lesen gespeicherte Boards. join gibt eine autorisierte Viewer-Sitzung zurück; halten Sie ihr Teilnehmer-Token aus Logs und der Browser-Persistenz heraus. Ein Board kann verfügbar sein, während eine Eingabe offline ist. Prüfen Sie deshalb den Live-Status jeder Eingabe separat.

Öffentlicher Zugriff ist beabsichtigt

Wenn visibility auf PUBLIC steht, kann jeder mit der Multiview-ID öffentliche Lese-, Statistik- und Beitrittsmethoden nutzen. Geben Sie öffentliche IDs nur so weit weiter wie beabsichtigt und setzen Sie Edge-Ratenbegrenzungen für öffentliche Beitritte. Fügen Sie eine Verarbeitungspipeline nur hinzu, wenn eine Quelle Transcodierung, Größenanpassung, Audioänderungen oder ein anderes Auslieferungsprotokoll benötigt.

12 Endpunkte
POST
/api/multiview/create
API-Token erforderlich

Erstellen Sie ein Multiview. Sofern active nicht false ist, startet Callaba auch die zugeordneten Eingänge und die Konferenz. Der Benutzerbereich wird aus dem API-Token abgeleitet; senden Sie deshalb kein user_id.

Nächster Aufruf: Lesen Sie mit getById die gespeicherten Eingänge und fordern Sie anschließend mit join ein Operator-Token an.

Eine Antwort mit Status 400 hat die Form { success: false, status, code, message, details }.

Parameter im Request-Body
Identität
name
string
Direktlink kopieren

Erforderlicher, für Operatoren sichtbarer Name, 1–120 Zeichen.

Layout
layout_id
string
Direktlink kopieren

Optionale Layout-Kennung: Die Engine verwendet standardmäßig 4-tiles.

overlay_settings
object
Direktlink kopieren

Optionale Overlay-Konfiguration für die Videowand.

Eingänge
inputs
array
Direktlink kopieren

Optionale Eingabedefinitionen: Unterstützte Laufzeitquellentypen umfassen direktes RTSP sowie SRT-, RTMP- und NDI-Varianten. Beginnen Sie mit einem leeren Array, wenn Sie die Wand bereitstellen möchten, bevor Sie Feeds hinzufügen.

Zugang
visibility
string
Direktlink kopieren

Optional PRIVATE oder PUBLIC. Der Standard ist PRIVATE.

Laufzeit
active
boolean
Direktlink kopieren

Optionaler anfänglicher Laufzeitstatus. Standardmäßig aktiv, sofern nicht explizit auf false gesetzt.

Multiview erstellen
curl --request POST \
  --url http://localhost/api/multiview/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Master control multiview",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [],
  "active": true
}'
Antwort
Identität
id
string
Direktlink kopieren

Stabile Multiview-Kennung.

name
string
Direktlink kopieren

Vom Operator vergebener Multiview-Name.

Layout
layout_id
string
Direktlink kopieren

Ausgewähltes Kachellayout, zum Beispiel 4-tiles.

inputs
array
Direktlink kopieren

Normalisierte Videoeingänge und deren Laufzeitbindungen.

Zugang
visibility
string
Direktlink kopieren

PRIVATE oder PUBLIC.

Laufzeit
conference_id
string
Direktlink kopieren

Zugeordnete Konferenz für die Bedienoberfläche.

active
boolean
Direktlink kopieren

Aktivstatus der Multiview-Laufzeit.

Antwort: Multiview erstellen
{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}
POST
/api/multiview/update
API-Token erforderlich
POST
/api/multiview/getCount
API-Token erforderlich
POST
/api/multiview/getAll
API-Token erforderlich
POST
/api/multiview/getById
API-Token erforderlich
POST
/api/multiview/start
API-Token erforderlich
POST
/api/multiview/stop
API-Token erforderlich
POST
/api/multiview/join
API-Token erforderlich
POST
/api/multiview-public/getById
Öffentlicher Endpunkt
POST
/api/multiview-public/getStat
Öffentlicher Endpunkt
POST
/api/multiview-public/join
Öffentlicher Endpunkt
DELETE
/api/multiview/remove
API-Token erforderlich
Workflow-Beispiele und Hilfe
REST-Lösungsrezept

Ein Operator-Multiview erstellen und verwalten

Erstellen Sie die Videowand mit geprüften Eingangs-Kacheln, aktualisieren Sie das Layout ohne neue Ressourcen-ID, starten Sie sie und prüfen Sie die gespeicherte Ressource vor der Freigabe eines öffentlichen Raums.

  1. Videowand erstellenDefinieren Sie Quellen-Kacheln, Layout, Sichtbarkeit und Operator-Einstellungen.POST /api/multiview/create
  2. Kacheln und Layout aktualisierenSenden Sie die vorhandene ID mit dem vollständig gewünschten Raum-, Quellen-, Sichtbarkeits- und Layoutzustand.POST /api/multiview/update
  3. Videowand startenStarten Sie das Multiview erst, nachdem seine Eingangsressourcen verfügbar sind.POST /api/multiview/start
  4. Verwaltete Videowand lesenPrüfen Sie Quellen- und Sichtbarkeitszustand über die authentifizierte Ressource, bevor Sie eine öffentliche ID freigeben.POST /api/multiview/getById
  5. Raumstatus lesenVerwenden Sie den öffentlichen Status-Aufruf nur für einen bewusst öffentlichen Raum.POST /api/multiview-public/getStat

Behandeln Sie eine öffentliche Multiview-ID als teilbares Zugriffsmittel. Halten Sie private Operator-Wände hinter authentifizierten Methoden.

Modulübergreifender Workflow

Einen Contribution-Feed empfangen, im Multiview überwachen und aufzeichnen

Stellen Sie zuerst den SRT-Ingest bereit, binden Sie dessen Ressourcen-ID an eine private Multiview-Kachel und verwenden Sie dieselbe fehlerfreie Quelle anschließend für eine Aufzeichnung.

  1. Contribution-Ingest erstellenKonfigurieren Sie Listener, Zugriff, Latenz und Routing und behalten Sie die zurückgegebene SRT-Server-ID.POST /api/srt-servers/create
  2. Ingest startenStarten Sie den Listener und bestätigen Sie die verbundene Contribution-Quelle vor dem Aufbau nachgelagerter Ressourcen.POST /api/srt-servers/start
  3. Private Videowand erstellenErstellen Sie das Multiview-Grundgerüst mit Layout, Sichtbarkeit und Overlay-Einstellungen.POST /api/multiview/create
  4. SRT-Kachel anbindenSetzen Sie source_id der Kachel auf die SRT-Server-ID und verwenden Sie den dokumentierten SRT-Software-Quellentyp.POST /api/multiview/update
  5. Operator-Monitoring startenStarten Sie die aktualisierte Wand und treten Sie über den authentifizierten Operator-Pfad bei.POST /api/multiview/start
  6. Archiv-Job erstellenWählen Sie denselben SRT-Server über das SRT-Eingabe-Preset des Recording-Moduls und legen Sie Format und Modus fest.POST /api/recording/create
  7. Aufzeichnung startenStarten Sie die Aufzeichnung erst bei stabilem Ingest und Operator-Multiview.POST /api/recording/start
  8. Aufzeichnungszustand prüfenÜberwachen Sie Bitrate, Bildrate, Ausgabezeit, Geschwindigkeit und Fortschritt unabhängig von der Videowand.POST /api/recording/getStat

Multiview wird derzeit mit einer leeren inputs-Liste erstellt. Fügen Sie die SRT-Kachel per Update hinzu: source_kind ist INPUT_TYPE_SRT_SOFTWARE und source_id ist die SRT-Server-ID. Der Recording-Create-Aufruf benötigt sein eigenes SRT-Eingabe-Preset; die Multiview-ID ist keine Recording-Quellen-ID.

Ask AI