Multiview

Mit Multiview überwachen Sie mehrere SRT-, RTMP- oder NDI-Eingänge gemeinsam in einem browserbasierten Multiviewer. Primär-, Backup-, Programm- und Rückkanal-Feeds bleiben auf einem Bildschirm sichtbar.

FunktionLive-Multiview für Operatoren erstellen

Geeignet, wennOperatoren benötigen eine Browser-Videowand für mehrere SRT-, RTMP- oder NDI-Feeds.

Anderes Modul verwenden, wennVerwenden Sie Webplayer für Zuschauer; Multiview ist für das operative Monitoring bestimmt.

1Live-Eingänge hinzufügen2Kacheln anordnen3Multiviewer öffnen

POST /api/multiview/create

Endpunkte filtern12 Endpunkte

Voraussetzungen

Verwenden Sie x-access-token zum Konfigurieren, Starten, Stoppen und Erstellen authentifizierter Viewer-Sitzungen. Wenn visibility PUBLIC ist, kann jeder mit der Multiview-ID seine öffentliche Ansicht, Statistiken und Beitrittsmethoden verwenden, also teilen Sie die ID nur so weit wie beabsichtigt.

Funktionen

create speichert die Multiview-, Layout-, Sichtbarkeits- und Anfangseingaben; eine leere Eingabeliste ist gültig.
update wendet die vollständige gewünschte Eingabeliste und das Layout an.
getAll, getCount und getById prüfen gespeicherte Multiviews.
start und stop steuern die Monitoring-Laufzeit.
join gibt die Browsersitzungsdetails für einen autorisierten Viewer zurück.
remove löscht die Multiview.

Beispiel-Workflow

Erstellen Sie ein privates Multiview mit dem gewünschten Layout; die Eingabeliste kann zunächst leer sein.
Aktualisieren Sie das Multiview mit dem vollständigen Satz von SRT-, RTMP- oder NDI-Eingängen.
Starten Sie die Multiview und rufen Sie die authentifizierte Join-Methode auf.
Öffnen Sie die zurückgegebene Viewer-Sitzung und bestätigen Sie den Live-Status jeder Eingabe.
Senden Sie die vollständige gewünschte Liste für spätere Updates; ausgelassene Eingaben werden entfernt.

Typische Anwendungsfälle

Überwachen Sie Primär- und Backup-Contribution-Feeds in einem Kontrollraum.
Geben Sie einem Remote-Produzenten eine Ansicht von Kameras, Programmausgabe und Rückgabefeeds.
Vergleichen Sie regionale oder Sprachausgaben vor der Verteilung.

Einschränkungen und Fehlerbehebung

Korrigieren Sie fehlende oder ungültige Namen, Eingabe-IDs, Sichtbarkeitswerte oder Teilnehmerdaten, bevor Sie die Anfrage erneut senden. Ein Multiview kann verfügbar bleiben, während einer seiner Eingänge offline ist; prüfen Sie deshalb den Live-Status jedes Eingangs einzeln.

Nächste Schritte

Verbinden Sie die vorgesehenen Feeds, prüfen Sie den Viewer-Zugriff und aktivieren Sie den öffentlichen Zugriff nur, wenn das Multiview geteilt werden soll.

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

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

Layout

layout_id

string

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

overlay_settings

object

Optionale Overlay-Konfiguration für die Videowand.

Eingänge

inputs

array

Optionale Eingabedefinitionen: Unterstützte Laufzeitquellentypen umfassen 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

Optional PRIVATE oder PUBLIC. Der Standard ist PRIVATE.

Laufzeit

active

boolean

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

Multiview erstellen

Antwort

Identität

string

Stabile Multiview-Kennung.

name

string

Vom Operator vergebener Multiview-Name.

Layout

layout_id

string

Ausgewähltes Kachellayout, zum Beispiel 4-tiles.

inputs

array

Normalisierte Videoeingänge und deren Laufzeitbindungen.

Zugang

visibility

string

PRIVATE oder PUBLIC.

Laufzeit

conference_id

string

Zugeordnete Konferenz für die Bedienoberfläche.

active

boolean

Aktivstatus der Multiview-Laufzeit.

Antwort: Multiview erstellen

JSON

{
  "_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

Aktualisieren Sie ein Multiview mit dem vollständig gewünschten Zustand. Callaba übernimmt die neue Eingangsliste und entfernt nicht mehr enthaltene Eingänge; lesen Sie deshalb das aktuelle Objekt, bevor Sie eine vorhandene Liste ersetzen.

Der authentifizierte Benutzerbereich stammt aus dem Token. Bei unbekannten IDs oder ungültigen Eingabefeldern gibt die Engine das übliche 400-Fehlerobjekt zurück.

Parameter im Request-Body

Ressourcen

string

Kennung der Multiview-Ressource.

Identität

name

string

Erforderlicher aktualisierter Name.

Layout

layout_id

string

Aktualisierte Layoutkennung.

overlay_settings

object

Aktualisierte Overlay-Konfiguration.

Eingänge

inputs

array

Der Dienst bereinigt Laufzeit-Restreams, die in der neuen Liste nicht mehr enthalten sind.

Zugang

visibility

string

PRIVATE oder PUBLIC.

Laufzeit

active

boolean

Aktualisierter Aktivstatus.

Multiview aktualisieren

curl --request POST \
  --url http://localhost/api/multiview/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "MULTIVIEW_ID",
  "name": "Master control multiview",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "SRT_SERVER_ID",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0
    }
  ],
  "active": true
}'

Antwort

Identität

string

Stabile Multiview-Kennung.

name

string

Vom Operator vergebener Multiview-Name.

Layout

layout_id

string

Ausgewähltes Kachellayout, zum Beispiel 4-tiles.

inputs

array

Normalisierte Videoeingänge und deren Laufzeitbindungen.

Zugang

visibility

string

PRIVATE oder PUBLIC.

Laufzeit

conference_id

string

Zugeordnete Konferenz für die Bedienoberfläche.

active

boolean

Aktivstatus der Multiview-Laufzeit.

Antwort: Multiview aktualisieren

JSON

{
  "_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/getCount

API-Token erforderlich

POST

/api/multiview/getAll

API-Token erforderlich

Listen Sie die Multiview-Ressourcen des authentifizierten Benutzers mit optionaler Paginierung, Sortierung und Filterung auf. Die Antwort besteht direkt aus einem Array.

Rufen Sie vor dem Aktualisieren oder Beitreten einer einzelnen Ressource getById auf.

Parameter im Request-Body

Paginierung

limit

number

Optionale maximale Anzahl von Einträgen.

skip

number

Optionale Anzahl zu überspringender Einträge.

Sortierung

sort

object

Optionales Sortierobjekt; der Standard ist die aufsteigende Erstellungszeit.

Filterung

filter

object

Optionaler Filter, immer kombiniert mit dem authentifizierten Benutzerumfang.

Alle Multiviews abrufen

Antwort

Ergebnis

[]

array

Array von Multiview-Ressourcen.

Identität

string

Stabile Multiview-Kennung.

name

string

Vom Operator vergebener Multiview-Name.

Layout

layout_id

string

Ausgewähltes Kachellayout, zum Beispiel 4-tiles.

inputs

array

Normalisierte Videoeingänge und deren Laufzeitbindungen.

Zugang

visibility

string

PRIVATE oder PUBLIC.

Laufzeit

conference_id

string

Zugeordnete Konferenz für die Bedienoberfläche.

active

boolean

Aktivstatus der Multiview-Laufzeit.

Antwort: Alle Multiviews abrufen

JSON

[
  {
    "_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/getById

API-Token erforderlich

Rufen Sie ein einzelnes Multiview im Bereich des authentifizierten Benutzers ab. Prüfen Sie die Ressource auf diese Weise vor dem Aktualisieren, Starten, Stoppen oder Beitreten.

Bei einer unbekannten oder einem anderen Benutzer zugeordneten ID gibt die Engine das übliche 400-Fehlerobjekt zurück.

Parameter im Request-Body

Ressourcen

string

Kennung der Multiview-Ressource.

Multiview nach ID abrufen

Antwort

Identität

string

Stabile Multiview-Kennung.

name

string

Vom Operator vergebener Multiview-Name.

Layout

layout_id

string

Ausgewähltes Kachellayout, zum Beispiel 4-tiles.

inputs

array

Normalisierte Videoeingänge und deren Laufzeitbindungen.

Zugang

visibility

string

PRIVATE oder PUBLIC.

Laufzeit

conference_id

string

Zugeordnete Konferenz für die Bedienoberfläche.

active

boolean

Aktivstatus der Multiview-Laufzeit.

Antwort: Multiview nach ID abrufen

JSON

{
  "_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/start

API-Token erforderlich

POST

/api/multiview/stop

API-Token erforderlich

POST

/api/multiview/join

API-Token erforderlich

Fordern Sie ein Operator-Teilnehmer-Token für ein Multiview des authentifizierten Benutzers an. Ist das Multiview noch nicht bereit, startet Callaba es vor der Token-Erstellung.

Speichern Sie participant_token weder in Protokollen noch dauerhaft im Browser; es handelt sich um eine kurzlebige Zugangsinformation.

Parameter im Request-Body

Ressourcen

string

Kennung der Multiview-Ressource.

Teilnehmer

participant_name

string

Erforderlicher Teilnehmer-Anzeigename.

participant_id

string

Optionale stabile Teilnehmer-ID. Die Engine erzeugt eine, wenn sie weggelassen wird.

Multiview beitreten

Antwort

Beitrittsergebnis

participant_token

string

LiveKit-Teilnehmer-Token für die Multiview-Konferenz.

LKRoomName

string

Name des Laufzeitraums.

participant_id

string

Aufgelöste Teilnehmeridentität.

multiview

object

Aktuelle Multiview-Ressource.

Antwort: Multiview beitreten

JSON

{
  "success": true,
  "multiview": {
    "_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
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

{
  "success": true,
  "multiview": {
    "_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
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

POST

/api/multiview-public/getById

Öffentlicher Endpunkt

Rufen Sie ein Multiview ohne API-Token nur dann ab, wenn seine gespeicherte Sichtbarkeit PUBLIC ist. Dieser Endpunkt ist für bewusst freigegebene Ansichten vorgesehen, nicht für authentifizierte Verwaltungsaktionen.

Bei einer unbekannten oder privaten ID gibt die Engine das übliche 400-Fehlerobjekt zurück.

Parameter im Request-Body

Ressourcen

string

Kennung der Multiview-Ressource.

Öffentliches Multiview nach ID abrufen

Antwort

Identität

string

Stabile Multiview-Kennung.

name

string

Vom Operator vergebener Multiview-Name.

Layout

layout_id

string

Ausgewähltes Kachellayout, zum Beispiel 4-tiles.

inputs

array

Normalisierte Videoeingänge und deren Laufzeitbindungen.

Zugang

visibility

string

PRIVATE oder PUBLIC.

Laufzeit

conference_id

string

Zugeordnete Konferenz für die Bedienoberfläche.

active

boolean

Aktivstatus der Multiview-Laufzeit.

Antwort: Öffentliches Multiview nach ID abrufen

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PUBLIC",
  "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-public/getStat

Öffentlicher Endpunkt

POST

/api/multiview-public/join

Öffentlicher Endpunkt

Treten Sie einem bewusst öffentlichen Multiview ohne API-Token bei. Callaba kann das Multiview starten, bevor das Teilnehmer-Token ausgegeben wird.

Begrenzen Sie die Aufrufrate am Netzwerkrand, geben Sie ausschließlich gezielt freigegebene öffentliche IDs weiter und behandeln Sie das zurückgegebene Teilnehmer-Token als kurzlebige Zugangsinformation.

Typische Anwendungsfälle

Öffnen Sie eine öffentliche Produktionsansicht über einen freigegebenen Operator-Link.
Betten Sie ein öffentliches Multiview in eine überwachte Standort- oder Veranstaltungsseite ein.

Parameter im Request-Body

Ressourcen

string

Kennung der Multiview-Ressource.

Teilnehmer

participant_name

string

Erforderlicher Gastanzeigename.

participant_id

string

Optionale stabile Teilnehmer-ID.

Öffentlichem Multiview beitreten

Antwort

Beitrittsergebnis

participant_token

string

LiveKit-Token für die öffentliche Multiview-Konferenz.

LKRoomName

string

Name des Laufzeitraums.

participant_id

string

Aufgelöste Teilnehmeridentität.

Antwort: Öffentlichem Multiview beitreten

JSON

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PUBLIC",
    "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
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PUBLIC",
    "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
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

DELETE

/api/multiview/remove

API-Token erforderlich

Zurück zuNDI-Konfiguration Weiter zuRestreams