NDI-Adapter

Verwenden Sie NDI-Adapter, um eine SRT-, RTMP- oder Videoanrufquelle als benannte NDI-Ausgabe für einen Switcher, ein Grafiksystem, einen Multiviewer oder einen Kontrollraum zu veröffentlichen.

FunktionQuelle als NDI-Ausgabe veröffentlichen

Geeignet, wennEine SRT-, RTMP- oder Videoanrufquelle soll als benannte NDI-Ausgabe erscheinen.

Anderes Modul verwenden, wennVerwenden Sie Erkannte NDI-Geräte, wenn die Quelle bereits im NDI-Netzwerk vorhanden ist.

1Quelle auswählen2NDI-Ausgabe benennen3Im Produktionssystem verwenden

POST /api/restream/create

Endpunkte filtern9 Endpunkte

Voraussetzungen

Alle Methoden erfordern einen gültigen x-access-token. Konfigurieren Sie zuerst die NDI-Vernetzung, erstellen Sie die vorgelagerte SRT-, RTMP- oder Videoanrufquelle und behalten Sie ihre Quell-ID bei.

Funktionen

create und update wählen die Eingabe aus und weisen den NDI-Gerätnamen zu.
getAll, getCount und getById prüfen NDI-Adapter.
start und stop steuern die NDI-Ausgabe.
getStat überprüft den laufenden Prozess.
remove löscht einen Adapter.

Beispiel-Workflow

{
  "restream_name": "Remote camera to NDI",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "output_settings": {
      "ndi_device_name": "Remote Camera 1"
    }
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}

Erstellen Sie den Adapter, starten Sie ihn, bestätigen Sie die Laufzeitstatistik und wählen Sie dann Remote Camera 1 auf dem empfangenden NDI-System aus.

Typische Anwendungsfälle

Bringen Sie eine SRT-Feldkamera in einen NDI-basierten Kontrollraum.
Zeigen Sie einen RTMP-Standort-Feed an einer NDI-Grafik-Workstation.
Veröffentlichen Sie einen Remote-Video-Gast als individuell wählbare NDI-Quelle.

Einschränkungen und Fehlerbehebung

Die Eingaberessource muss vorhanden sein und ein nutzbares Mediensignal liefern. Verwenden Sie stabile, eindeutige Gerätenamen, damit Operatoren die Quellen sicher erkennen. Ein gespeicherter Adapter läuft nicht automatisch; prüfen Sie getStat, bevor Sie ihn auf Sendung verwenden.

Nächste Schritte

Bestätigen Sie die Ausgabe auf dem empfangenden NDI-System und verbinden Sie sie dann mit dem erforderlichen Schalt-, Überwachungs- oder Aufzeichnungsworkflow.

REST-Lösungsrezept

Eine NDI-Quelle in einen Ausgabe-Workflow überführen

Erstellen Sie einen Adapter von einer geprüften NDI-Quelle zum benötigten Ausgang, starten Sie ihn und prüfen Sie den Prozess.

Bridge erstellenWählen Sie NDI-Eingang sowie Protokoll und Verarbeitung des Ziels.POST /api/restream/create
Adapter startenStarten Sie nach Verfügbarkeit von NDI-Quelle und Ziel.POST /api/restream/start
Prozess prüfenLesen Sie die Laufzeitstatistik vor der Nutzung des Ausgangs.POST /api/restream/getStat

Eine erfolgreiche Create-Antwort bestätigt die Konfiguration, nicht den Medienzustand. Starten Sie die Ressource und prüfen Sie ihre Laufzeitstatistik, bevor Sie Produktionsverkehr senden.

Callaba-NDI-Produkt öffnen Live-Operator-Demo öffnen

Modulübergreifender Workflow

NDI-Discovery konfigurieren, Netzwerksicht prüfen und einen NDI-Ausgang veröffentlichen

Wenden Sie die Discovery-Konfiguration der Instanz an, bestätigen Sie die erwarteten NDI-Geräte und überführen Sie anschließend eine unterstützte verwaltete Quelle in einen benannten NDI-Ausgang.

NDI-Netzwerkeinstellungen anwendenSetzen Sie Maschinenname, Discovery-Server, explizite Quellen-IPs oder die geprüfte vollständige JSON-Konfiguration.POST /api/devices/updateNDIConfiguration
Geräteinventar prüfenListen Sie die aktuelle Netzwerksicht auf und bestätigen Sie erwartete Namen und Adressen.POST /api/devices/getAll
Discovery-Aktivität prüfenBestätigen Sie die aktuelle Aktivität des gewählten Eintrags, bevor Sie sich auf den Netzwerkpfad verlassen.POST /api/devices/getStat
NDI-Publisher erstellenWählen Sie einen unterstützten verwalteten Eingang und konfigurieren Sie Namen und Stream-Steuerung für OUTPUT_TYPE_NDI_DEVICE.POST /api/restream/create
NDI-Ausgabe startenStarten Sie den Adapter, wenn verwaltete Quelle und NDI-Zielnetz verfügbar sind.POST /api/restream/start
Publisher-Prozess prüfenPrüfen Sie Bitrate, FPS, Geschwindigkeit und Fortschritt vor der Übergabe des NDI-Namens.POST /api/restream/getStat

Ein Eintrag unter den erkannten Geräten belegt die Netzwerksicht; seine ID ist nicht der Adapter-Eingang. Die veröffentlichten Adapter-Beispiele akzeptieren verwaltetes SRT, RTMP GoPro oder Konferenzteilnehmer und veröffentlichen OUTPUT_TYPE_NDI_DEVICE.

Produktseite der Video API öffnen Live-Operator-Demo öffnen Zum API-Workflow-Hub zurückkehren

POST

/api/restream/create

API-Token erforderlich

Veröffentlichen Sie mit dieser Methode eine verwaltete Quelle als NDI-Gerät im Netzwerk, damit sie in Bildmischern, Grafiksystemen und anderen Produktions-Clients verfügbar ist.

Die gespeicherte NDI-Bridge verwendet die Felder eines Restream-Jobs mit einer NDI-Geräteausgabe und module_name: MODULE_NDI_ADAPTERS. Für operatorgesteuerte Starts steht ein Beispiel für vMix Script bereit.

Verwalteter Ingest zu NDI

Verwenden Sie diese Voreinstellung, wenn ein verwalteter SRT-Server als benannte Cloud-NDI-Ausgabe bereitgestellt werden soll.

SRT-Server zum NDI-Gerät

Dies ist die direkteste Brücke zwischen einem vorhandenen SRT-Ingest-Endpunkt und einer NDI-Ausgabe.

SRT-Server zum NDI-Gerät

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c00",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Camera 1",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c00",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Camera 1",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

RTMP-Server zum NDI-Gerät

Dies ist nützlich für Hardware- oder Softwarequellen, die bereits per RTMP in der Plattform ankommen.

RTMP-Server zum NDI-Gerät

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "GoPro RTMP to Cloud NDI",
  "input": {
    "input_type": "INPUT_TYPE_RTMP_GOPRO",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c10",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "GoPro RTMP to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI GoPro",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "GoPro RTMP to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "GoPro RTMP to Cloud NDI",
  "input": {
    "input_type": "INPUT_TYPE_RTMP_GOPRO",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c10",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "GoPro RTMP to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI GoPro",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "GoPro RTMP to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

Echtzeit-Teilnehmer an NDI

Verwenden Sie diese Voreinstellung, wenn ein Teilnehmer-Feed aus einem Videoanruf in eine NDI-fähige Produktionsumgebung zurückgeführt werden soll.

Konferenzteilnehmer zum NDI-Gerät

Dies ist die konferenzseitige Variante des gleichen Adaptermusters.

Konferenzteilnehmer zum NDI-Gerät

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Speaker feed to Cloud NDI",
  "input": {
    "input_type": "INPUT_TYPE_MODULE_CONFERENCES_PARTICIPANT",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c20",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Speaker feed to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Speaker",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Speaker feed to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Speaker feed to Cloud NDI",
  "input": {
    "input_type": "INPUT_TYPE_MODULE_CONFERENCES_PARTICIPANT",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c20",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Speaker feed to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Speaker",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Speaker feed to Cloud NDI",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

Parameter im Request-Body

Identität

restream_name

string

Dashboard-Bezeichnung: Adaptername.

Lesbarer Name des NDI-Adapterjobs.

Quelle

input.input_type

string

Dashboard-Bezeichnung: Quelle.

Tatsächlich unterstützte Laufzeitfamilien umfassen verwaltete SRT-Server-Eingänge, verwaltete RTMP-Server-Eingänge und Eingänge von Konferenzteilnehmern.

input.input_module_id

string

Kennung der ausgewählten Quellressource im Erstellungsformular.

Ziel

output.output_type

string

Dashboard-Bezeichnung: Zielausgabe.

Dieses Modul verbindet die Ausgabeseite mit OUTPUT_TYPE_NDI_DEVICE.

output.output_settings.ndi_device_name

string

Dashboard-Bezeichnung: NDI®-Gerätename.

Name des zu erstellenden Cloud-NDI-Ausgabegeräts.

output.output_settings.timestamp_offset

integer

Dashboard-Bezeichnung: Zeitstempelversatz (ns).

Optionale Zeitstempelverschiebung in Nanosekunden.

output.output_settings.av_stream_control_mode

string

Dashboard-Bezeichnung: Audio-/Video-Steuerung.

Steuert, ob der Adapter Audio, Video oder beides veröffentlichen soll.

Laufzeit

module_name

string

Die Benutzeroberfläche speichert diesen Job als MODULE_NDI_ADAPTERS, obwohl sie die Restream-Backend-Pfade verwendet.

active

boolean

Dashboard-Bezeichnung: Einmal erstellt aktivieren.

Steuert, ob der Adapter direkt aktiv sein soll.

NDI-Adapter erstellen

curl --request POST \
  --url http://localhost/api/restream/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c00",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Camera 1",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true
}'

Antwort

Identität

_id / id / restream_name

mixed

Kennungen und der gespeicherte Adaptername.

Quelle

input[]

array

Gespeicherte Quelldefinition des Adapters.

Ziel

output[]

array

Gespeicherte NDI-Ausgabedefinition des Adapters.

Laufzeit

module_name / active / created / modified

mixed

Modulmarker, aktiver Zustand und Backend-verwaltete Zeitstempel.

Betriebsergebnis

success

boolean

Bei erfolgreicher Ausführung enthält die Antwort success: true.

Antwort: NDI-Adapter erstellen

JSON

{
  "_id": "67f200000000000000000001",
  "id": "67f200000000000000000001",
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": [
    {
      "_id": "67f200000000000000000010",
      "id": "67f200000000000000000010",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "66015d2997300f9385d32c00",
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "output": [
    {
      "_id": "67f200000000000000000020",
      "id": "67f200000000000000000020",
      "output_type": "OUTPUT_TYPE_NDI_DEVICE",
      "output_settings": {
        "ndi_device_name": "Cloud NDI Camera 1",
        "timestamp_offset": 0,
        "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
      },
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true,
  "created": "2026-03-24T11:00:00.000Z",
  "modified": "2026-03-24T11:00:00.000Z",
  "success": true
}

POST

/api/restream/getCount

API-Token erforderlich

POST

/api/restream/getAll

API-Token erforderlich

Rufen Sie mit dieser Methode alle gespeicherten NDI-Bridge-Jobs für Operator-Dashboards und Inventaransichten ab.

Die zurückgegebenen Adapterobjekte verwenden die Felder eines Restream-Jobs und sind auf MODULE_NDI_ADAPTERS begrenzt.

Parameter im Request-Body

limit

integer

Optionale Seitengröße für die Adapterliste.

skip

integer

Optionaler Offset für die paginierte Liste.

sort

object

Die Liste ist standardmäßig nach { created: 1 } sortiert.

filter

object

Filtert die Adapterliste nach module_name: MODULE_NDI_ADAPTERS.

Alle NDI-Adapter abrufen

Antwort

array of adapter objects

array

Das Backend gibt ein Array der als NDI-Adapter gefilterten Restream-Objekte zurück.

Antwort: Alle NDI-Adapter abrufen

JSON

[
  {
    "_id": "67f200000000000000000001",
    "id": "67f200000000000000000001",
    "restream_name": "Camera 1 to Cloud NDI via SRT",
    "input": [
      {
        "_id": "67f200000000000000000010",
        "id": "67f200000000000000000010",
        "input_type": "INPUT_TYPE_SRT_SOFTWARE",
        "input_module_id": "66015d2997300f9385d32c00",
        "module_name": "MODULE_RESTREAM"
      }
    ],
    "output": [
      {
        "_id": "67f200000000000000000020",
        "id": "67f200000000000000000020",
        "output_type": "OUTPUT_TYPE_NDI_DEVICE",
        "output_settings": {
          "ndi_device_name": "Cloud NDI Camera 1",
          "timestamp_offset": 0,
          "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
        },
        "module_name": "MODULE_RESTREAM"
      }
    ],
    "module_name": "MODULE_NDI_ADAPTERS",
    "active": true,
    "created": "2026-03-24T11:00:00.000Z",
    "modified": "2026-03-24T11:00:00.000Z",
    "success": true
  }
]

POST

/api/restream/getById

API-Token erforderlich

Rufen Sie mit dieser Methode eine einzelne NDI-Bridge zur Prüfung, Bearbeitung oder für einen kontrollierten Neustart ab.

Die Antwort enthält die gespeicherte Quellzuordnung, die NDI-Ausgabeeinstellungen und den vorgesehenen Aktivierungsstatus des Adapters.

Parameter im Request-Body

string

Kennung des Adapterjobs, den Sie laden möchten.

NDI-Adapter nach ID abrufen

Antwort

adapter object

object

Das vollständig aufgelöste Adapterobjekt auf Basis eines Restream-Jobs.

Antwort: NDI-Adapter nach ID abrufen

JSON

{
  "_id": "67f200000000000000000001",
  "id": "67f200000000000000000001",
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": [
    {
      "_id": "67f200000000000000000010",
      "id": "67f200000000000000000010",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "66015d2997300f9385d32c00",
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "output": [
    {
      "_id": "67f200000000000000000020",
      "id": "67f200000000000000000020",
      "output_type": "OUTPUT_TYPE_NDI_DEVICE",
      "output_settings": {
        "ndi_device_name": "Cloud NDI Camera 1",
        "timestamp_offset": 0,
        "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
      },
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true,
  "created": "2026-03-24T11:00:00.000Z",
  "modified": "2026-03-24T11:00:00.000Z",
  "success": true
}

POST

/api/restream/update

API-Token erforderlich

Aktualisieren Sie mit dieser Methode eine vorhandene NDI-Bridge, um die Quelle neu zuzuordnen, Ausgabeeinstellungen anzupassen oder den vorgesehenen Aktivierungsstatus zu ändern.

Der Adapter behält seine ID und den Bereich MODULE_NDI_ADAPTERS. Sie können die Bridge daher ändern, ohne sie neu anzulegen.

Parameter im Request-Body

string

Kennung des aktualisierten Adapterauftrags.

adapter payload fields

mixed

Der Request-Body entspricht create und verwendet weiterhin das Anfrageformat des zugrunde liegenden Restream-Moduls.

NDI-Adapter aktualisieren

curl --request POST \
  --url http://localhost/api/restream/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Camera 1 to Cloud NDI updated",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c00",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Camera 1",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": false,
  "id": "67f200000000000000000001"
}'

curl --request POST \
  --url http://localhost/api/restream/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream_name": "Camera 1 to Cloud NDI updated",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "input_module_id": "66015d2997300f9385d32c00",
    "input_stream_url": "",
    "input_stream_listen_port": {},
    "input_settings": {},
    "input_stream_id": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "output": {
    "output_type": "OUTPUT_TYPE_NDI_DEVICE",
    "application": "IO_APPLICATION_CALLABA_CLOUD_INGRESS_API",
    "output_stream_url": "",
    "output_stream_listen_port": {},
    "output_settings": {
      "ndi_device_name": "Cloud NDI Camera 1",
      "timestamp_offset": 0,
      "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
    },
    "output_stream_key": "",
    "entity_name": "Camera 1 to Cloud NDI via SRT",
    "module_name": "MODULE_RESTREAM"
  },
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": false,
  "id": "67f200000000000000000001"
}'

Antwort

updated adapter object

object

Das Backend gibt das aktualisierte Adapterobjekt zurück.

Antwort: NDI-Adapter aktualisieren

JSON

{
  "_id": "67f200000000000000000001",
  "id": "67f200000000000000000001",
  "restream_name": "Camera 1 to Cloud NDI updated",
  "input": [
    {
      "_id": "67f200000000000000000010",
      "id": "67f200000000000000000010",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "66015d2997300f9385d32c00",
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "output": [
    {
      "_id": "67f200000000000000000020",
      "id": "67f200000000000000000020",
      "output_type": "OUTPUT_TYPE_NDI_DEVICE",
      "output_settings": {
        "ndi_device_name": "Cloud NDI Camera 1",
        "timestamp_offset": 0,
        "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
      },
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": false,
  "created": "2026-03-24T11:00:00.000Z",
  "modified": "2026-03-24T11:15:00.000Z",
  "success": true
}

POST

/api/restream/start

API-Token erforderlich

Starten Sie mit dieser Methode eine gespeicherte Quelle als NDI-Gerät im Netzwerk, etwa zu Produktionsbeginn oder bei einer Übergabe.

Der vorhandene Bridge-Job wird aktiviert, ohne seine Konfiguration zu ändern. Das eignet sich besonders für schaltflächengesteuerte Operator-Workflows.

Parameter im Request-Body

string

Kennung des zu startenden Adapterauftrags.

NDI-Adapter starten

Antwort

started adapter object

object

Das Backend markiert den Adapter als aktiv und gibt das aktualisierte Objekt zurück.

Antwort: NDI-Adapter starten

JSON

{
  "_id": "67f200000000000000000001",
  "id": "67f200000000000000000001",
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": [
    {
      "_id": "67f200000000000000000010",
      "id": "67f200000000000000000010",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "66015d2997300f9385d32c00",
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "output": [
    {
      "_id": "67f200000000000000000020",
      "id": "67f200000000000000000020",
      "output_type": "OUTPUT_TYPE_NDI_DEVICE",
      "output_settings": {
        "ndi_device_name": "Cloud NDI Camera 1",
        "timestamp_offset": 0,
        "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
      },
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true,
  "created": "2026-03-24T11:00:00.000Z",
  "modified": "2026-03-24T11:20:00.000Z",
  "success": true
}

POST

/api/restream/stop

API-Token erforderlich

Stoppen Sie mit dieser Methode die Veröffentlichung eines NDI-Geräts im Netzwerk, ohne die gespeicherte Bridge zu löschen.

Der Aufruf ergänzt start: Das NDI-Signal wird beendet, die Adapterkonfiguration bleibt jedoch für eine spätere Wiederverwendung erhalten.

Parameter im Request-Body

string

Kennung des zu stoppenden Adapterauftrags.

NDI-Adapter stoppen

Antwort

stopped adapter object

object

Das Backend markiert den Adapter als inaktiv und gibt das aktualisierte Objekt zurück.

Antwort: NDI-Adapter stoppen

JSON

{
  "_id": "67f200000000000000000001",
  "id": "67f200000000000000000001",
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": [
    {
      "_id": "67f200000000000000000010",
      "id": "67f200000000000000000010",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "66015d2997300f9385d32c00",
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "output": [
    {
      "_id": "67f200000000000000000020",
      "id": "67f200000000000000000020",
      "output_type": "OUTPUT_TYPE_NDI_DEVICE",
      "output_settings": {
        "ndi_device_name": "Cloud NDI Camera 1",
        "timestamp_offset": 0,
        "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
      },
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": false,
  "created": "2026-03-24T11:00:00.000Z",
  "modified": "2026-03-24T11:25:00.000Z",
  "success": true
}

DELETE

/api/restream/remove

API-Token erforderlich

Entfernen Sie mit dieser Methode eine NDI-Bridge, die nicht mehr in Operator-Workflows erscheinen oder erneut gestartet werden soll.

Der Aufruf stoppt den Adapter und löscht seine gespeicherte Konfiguration. Führen Sie ihn erst aus, wenn die NDI-Ausgabe im Netzwerk nicht mehr benötigt wird.

Abfrageparameter

string

Kennung des zu löschenden Adapterauftrags.

NDI-Adapter entfernen

Antwort

removed adapter object

object

Nach dem Entfernen dient das zuvor geladene Adapterobjekt als Referenz für den gelöschten Eintrag.

Antwort: NDI-Adapter entfernen

JSON

{
  "_id": "67f200000000000000000001",
  "id": "67f200000000000000000001",
  "restream_name": "Camera 1 to Cloud NDI via SRT",
  "input": [
    {
      "_id": "67f200000000000000000010",
      "id": "67f200000000000000000010",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "66015d2997300f9385d32c00",
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "output": [
    {
      "_id": "67f200000000000000000020",
      "id": "67f200000000000000000020",
      "output_type": "OUTPUT_TYPE_NDI_DEVICE",
      "output_settings": {
        "ndi_device_name": "Cloud NDI Camera 1",
        "timestamp_offset": 0,
        "av_stream_control_mode": "AV_STREAM_CONTROL_VIDEO_AUDIO"
      },
      "module_name": "MODULE_RESTREAM"
    }
  ],
  "module_name": "MODULE_NDI_ADAPTERS",
  "active": true,
  "created": "2026-03-24T11:00:00.000Z",
  "modified": "2026-03-24T11:00:00.000Z",
  "success": true
}

POST

/api/restream/getStat

API-Token erforderlich

Zurück zuErkannte NDI-Geräte Weiter zuNDI-Konfiguration