NDI discovered devices
NDI discovered devices records the NDI sources currently visible to this Callaba instance. Configure NDI interfaces and discovery servers before using these methods; all calls require x-access-token.
Refresh and read discovery
Run sync after expected senders are online to update the saved inventory. getAll, getCount, and getById read those entries. getStat answers whether a saved device is currently being discovered. Use it when an entry appears intermittent rather than assuming a saved record proves its sender is reachable.
Record maintenance
update changes supported record fields. remove removes a stale saved entry only; it does not stop or block the NDI sender, and the source can return on a later discovery sync.
Network diagnosis
A missing device can result from interface selection, discovery-server reachability, routing, firewall rules, or sender configuration. Check NDI network configuration and run sync again before treating an absent source as a media failure.
Use Get all discovered devices for an inventory of NDI sources known to Callaba Engine.
Apply a device-type filter when needed, and refresh the list when an operator view must reflect recent discovery changes.
Optional page size for the device list.
Optional offset for paginated listing.
Optional sort descriptor. The UI uses { created: 1 }.
Operator-facing NDI list calls usually filter by type: DEVICE_TYPE_NDI.
curl --request POST \
--url http://localhost/api/devices/getAll \
--header 'x-access-token: <your_api_token>' \
--header 'Content-Type: application/json' \
--data '{
"limit": 10,
"skip": 0,
"sort": {
"created": 1
},
"filter": {
"type": "DEVICE_TYPE_NDI"
}
}'The backend returns a bare array of stored discovered-device rows.
Timestamp of the last discovery-side refresh for this device.
[
{
"_id": "67f100000000000000000001",
"id": "67f100000000000000000001",
"name": "Studio Camera A",
"type": "DEVICE_TYPE_NDI",
"ndi_name": "Studio Camera A",
"url_address": "192.168.10.41:5960",
"created": "2026-03-24T10:00:00.000Z",
"discovered_last_time": "2026-03-24T10:00:05.000Z",
"success": true
}
]Workflow examples and help
Inventory discovered NDI sources
List discovered devices, select the intended source by id, and inspect its current discovery activity before building an adapter.
- List NDI sourcesRead the current discovered-device inventory.
POST /api/devices/getAll - Check activityInspect the current discovery state before using the source downstream.
POST /api/devices/getStat
Discovery reflects the current network view. Confirm the source name, address, and availability in the production segment.