media server logo
PricingSign inLaunch NDI streaming
Operator documentation

NDI discovery and configuration

Use this runbook to discover the intended NDI devices and operate network configuration and adapters from the Callaba UI. It keeps the UI task, verification and automation path together.

UINDI® Tools → NDI® discovered devices

What this solves

This procedure gives an operator one controlled path to discover the intended NDI devices and operate network configuration and adapters from the Callaba UI.

When to use it

Use it during initial setup, a planned change or incident recovery when you need to discover the intended NDI devices and operate network configuration and adapters from the Callaba UI.

Dashboard path

NDI® Tools → NDI® discovered devicesRoute/ndi-tools/list-ndi-discovered-devices
NDI® Tools → NDI® adaptersRoute/ndi-tools/ndi-adapters/list
NDI® Tools → NDI® configurationRoute/ndi-tools/ndi-configuration

Prerequisites

  • Administrator access to the Callaba instance and permission to change this module.

  • A maintenance window or a non-production resource plus a real test source or client.

  • A record of the current values, allocated ports and credentials before you save changes.

Steps in the Callaba UI

  1. 01

    In the dashboard sidebar, follow NDI® Tools → NDI® discovered devices. Open the source-backed route /ndi-tools/list-ndi-discovered-devices. In the dashboard sidebar, follow NDI® Tools → NDI® adapters. Open the source-backed route /ndi-tools/ndi-adapters/list. In the dashboard sidebar, follow NDI® Tools → NDI® configuration. Open the source-backed route /ndi-tools/ndi-configuration.

  2. 02

    Before changing NDI discovery and configuration, record these current values: machinename, discovery, ips, jsonNDI, ndi_device_name, restream_name.

  3. 03

    In NDI discovery and configuration, set machinename, discovery, ips, jsonNDI, ndi_device_name, restream_name so you can discover the intended NDI devices and operate network configuration and adapters from the Callaba UI. Keep unrelated values unchanged.

  4. 04

    Run Save [page-user-settings-form-save]. Wait for the form or listing to settle before testing another variable.

  5. 05

    Use a real source, destination or browser client and confirm these live signals: processData, device_list, processing, active.

Controls to review
  • machinename
  • discovery
  • ips
  • jsonNDI
  • ndi_device_name
  • restream_name
Actions to run
  • Savepage-user-settings-form-save
Signals to verify
  • processData
  • device_list
  • processing
  • active

Expected result

The runbook is complete when Save [page-user-settings-form-save] succeeds and a real workflow reports processData, device_list, processing, active.

Troubleshooting

The saved change does not appear

Confirm the save response, refresh the module once and compare the visible values with the record made before the change. Correct validation errors before retrying.

The connection or playback path fails

Check the exact host, port, protocol, credentials and firewall path used by the real client. Test one source and one destination before restoring the full workflow.

The module starts but health is unstable

Return to the last known working values, inspect live statistics and process errors, then reintroduce one change at a time.

Product page / Exact API reference

Continue with the commercial product context or automate the same operation from its verified API endpoint.

Product pageCloud NDI productionExact API referenceExact API reference 1 · update-ndi-configurationExact API referenceExact API reference 2 · get-all-ndi-discovered-devices