media server logo
PreiseAnmeldenLaunch NDI streamingEmpfohlene Region: Frankfurt.
API-DokumentationÜbersicht
Erkannte NDI-Geräte
NDI-Adapter
NDI-Konfiguration
Multiview
Videoanrufe
Dokumentationsnavigation ein- oder ausblenden
Callaba-Startseite

NDI-Konfiguration

Verwenden Sie die NDI-Konfiguration, um die Netzwerkschnittstellen und Discovery-Server festzulegen, über die Callaba NDI-Quellen erkennt und veröffentlicht.

FunktionNDI-Discovery konfigurieren

Geeignet, wennSie müssen NDI-Schnittstellen oder Discovery-Server auswählen, insbesondere in gerouteten Netzwerken.

Anderes Modul verwenden, wennVerwenden Sie Erkannte NDI-Geräte, um Quellen zu prüfen; ändern Sie die globale Discovery nicht nur zur Auswahl einer Quelle.

1Netzwerk festlegen2Discovery anwenden3Quellen prüfen
POST /api/devices/updateNDIConfiguration

Voraussetzungen

Die Aktualisierungsmethode erfordert einen gültigen x-access-token. Kennen Sie die Schnittstellenadressen, den Maschinennamen und die Discovery-Server-Adressen, die vom Engine-Host aus erreichbar sind.

Funktionen

update wendet den NDI-Maschinennamen, ausgewählte IP-Schnittstellen und die Discovery-Server-Konfiguration für die Instanz an.

Beispiel-Workflow

{
  "machine_name": "Callaba Studio Gateway",
  "ip_addresses": ["192.168.10.20"],
  "discovery_servers": ["192.168.10.10"]
}
  1. Wenden Sie die Konfiguration mit einer Schnittstelle an, die über das NDI-Netzwerk erreichbar ist.
  2. Synchronisieren Sie die erkannten NDI-Geräte.
  3. Prüfen Sie, ob die erwarteten Sender erscheinen und als aktiv gemeldet werden.

Typische Anwendungsfälle

  • Geben Sie einem Studio-Gateway eine vorhersehbare NDI-Identität.
  • Beschränken Sie den NDI-Datenverkehr auf einem Host mit mehreren Schnittstellen auf das Produktionsnetzwerk.
  • Erreichen Sie Sender in gerouteten Netzwerken über einen NDI Discovery Server.

Einschränkungen und Fehlerbehebung

Eine nicht erreichbare Schnittstelle oder ein Discovery-Server verhindert das Erscheinen erwarteter Quellen. Netzwerk-Routing, Multicast-Richtlinie, NDI-Versionskompatibilität und Host-Firewall-Regeln gelten weiterhin.

Nächste Schritte

Öffnen Sie Erkannte NDI-Geräte, um die Sichtbarkeit zu prüfen, und erstellen Sie anschließend einen NDI-Adapter für eine verwaltete Ausgabe.

REST-Lösungsrezept

NDI-Discovery für das vorgesehene Netzwerk konfigurieren

Wenden Sie die geprüfte NDI-Discovery-Konfiguration an und bestätigen Sie anschließend das Quelleninventar im Geräte-Modul.

  1. Discovery-Einstellungen anwendenSenden Sie die geprüfte Konfiguration für das Instanznetz.POST /api/devices/updateNDIConfiguration
  2. Erkannte Quellen prüfenBestätigen Sie, dass nur das erwartete Quelleninventar erscheint.POST /api/devices/getAll

Netzwerksichtbarkeit, Multicast-Richtlinie und NDI-Zugriff gelten weiterhin. Eine gespeicherte Konfiguration garantiert keine Discovery über geroutete Segmente.

Callaba-NDI-Produkt öffnenLive-Operator-Demo öffnen
POST
/api/devices/updateNDIConfiguration
API-Token erforderlich

Verwenden Sie NDI-Konfiguration aktualisieren, um instanzweite NDI-Einstellungen wie Rechnername, Discovery-Server, feste Netzwerk-IP-Adressen oder eine vollständig importierte JSON-Konfiguration anzuwenden.

Eine einzige Speicherung kann das Verhalten der gesamten Instanz in der NDI-Umgebung ändern, nicht nur einen einzelnen Listeneintrag.

Nutzen Sie den Endpunkt, um die NDI-Discovery für diese Instanz gezielt zu konfigurieren und die Einstellungen dauerhaft konsistent zu halten.

Konfiguration auf App-Ebene

Verwenden Sie dies, wenn die sichtbaren Formularfelder ausreichen und der JSON-Editor mit diesen Werten synchron bleiben soll.

Minimale formularbasierte Aktualisierung

Dies spiegelt den normalen UI-Pfad wider, in dem Formular- und JSON-Änderungen vor dem Speichern synchron bleiben.

Minimale formularbasierte Aktualisierung
Code kopieren
curl --request POST \
  --url http://localhost/api/devices/updateNDIConfiguration \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "machinename": "CALLABA CLOUD STUDIO",
  "ips": "192.168.10.41, 192.168.10.52",
  "discovery": "192.168.10.20:5959",
  "json": {
    "ndi": {
      "machinename": "CALLABA CLOUD STUDIO",
      "networks": {
        "discovery": "192.168.10.20:5959",
        "ips": "192.168.10.41, 192.168.10.52"
      }
    }
  }
}'
Vollständige JSON-basierte Aktualisierung

Dies entspricht dem Live-Editor und dem Importablauf in der Benutzeroberfläche.

Vollständige JSON-basierte Aktualisierung
Code kopieren
curl --request POST \
  --url http://localhost/api/devices/updateNDIConfiguration \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "machinename": "CALLABA CLOUD STUDIO",
  "ips": "192.168.10.41, 192.168.10.52",
  "discovery": "192.168.10.20:5959, 192.168.10.21:5959",
  "json": {
    "ndi": {
      "machinename": "CALLABA CLOUD STUDIO",
      "networks": {
        "discovery": "192.168.10.20:5959, 192.168.10.21:5959",
        "ips": "192.168.10.41, 192.168.10.52"
      }
    }
  }
}'
Parameter im Request-Body
Formularfelder
machinename
string
Direktlink kopieren

Dashboard-Bezeichnung: Maschinenname.

Optionale Überschreibung des Maschinennamens, den der Dienst im NDI-Netzwerk bekannt gibt.

discovery
string
Direktlink kopieren

Dashboard-Bezeichnung: Discovery.

Kommagetrennte Liste der Discovery-Server. Der UI-Tooltip erlaubt explizit Portnummern als Teil der Werte.

ips
string
Direktlink kopieren

Dashboard-Bezeichnung: Netzwerk-IPs.

Kommagetrennte Liste expliziter Quell-IPs für Szenarien zur subnetzübergreifenden Erkennung.

JSON-Editor
json
object
Direktlink kopieren

Die Benutzeroberfläche synchronisiert dieses Objekt mit den sichtbaren Formularfeldern und importierten Konfigurationsdateien.

NDI-Konfiguration aktualisieren
Code kopieren
curl --request POST \
  --url http://localhost/api/devices/updateNDIConfiguration \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "machinename": "CALLABA CLOUD STUDIO",
  "ips": "192.168.10.41, 192.168.10.52",
  "discovery": "192.168.10.20:5959",
  "json": {
    "ndi": {
      "machinename": "CALLABA CLOUD STUDIO",
      "networks": {
        "discovery": "192.168.10.20:5959",
        "ips": "192.168.10.41, 192.168.10.52"
      }
    }
  }
}'
Antwort
Betriebsergebnis
success
boolean
Direktlink kopieren

Das Backend gibt { success: true } nach Validierung, Schreiben und Anwenden der aktualisierten NDI-Konfiguration zurück.

Anwendung
side effects
config write + apply path
Direktlink kopieren

Das Backend schreibt die kompilierte Konfiguration, speichert ndi_settings auf dem App-Objekt und stößt den Anwendungsprozess an, mit dem die Engine die neue NDI-Konfiguration übernimmt.

Antwort: NDI-Konfiguration aktualisieren
JSON
Code kopieren
{
  "success": true
}
Zurück zuNDI-AdapterWeiter zuMultiview