Metadata SDK — nx/sdk/analytics/helpers/ headers missing from Server Plugin SDK package
Hi all,
I'm building a custom analytics (metadata) plugin for Nx Witness and hitting missing headers in the SDK package I have. Hoping someone can confirm which package is correct, or whether these files were relocated.
Environment
- Nx Witness Server: 6.1.1
- SDK package:
server_plugin_sdk(downloaded from the developer portal) - OS: Windows 11 x64
- Toolchain: Visual Studio 2022 (MSVC 19.44), CMake 4.x
Problem
My plugin builds against the analytics helper classes, but the SDK package I downloaded has no src/nx/sdk/analytics/helpers/ directory at all. These four are missing:
src/nx/sdk/analytics/helpers/plugin.h (nx::sdk::analytics::Plugin)
src/nx/sdk/analytics/helpers/engine.h (nx::sdk::analytics::Engine)
src/nx/sdk/analytics/helpers/consuming_device_agent.h (nx::sdk::analytics::ConsumingDeviceAgent)
src/nx/sdk/analytics/helpers/object_metadata_packet.h (nx::sdk::analytics::ObjectMetadataPacket)Compiler output:
error C1083: Cannot open include file: 'nx/sdk/analytics/helpers/plugin.h':
No such file or directoryWhat the package does contain
The analytics interfaces are present, e.g.:
src/nx/sdk/analytics/i_engine.h
src/nx/sdk/analytics/i_device_agent.h
src/nx/sdk/analytics/i_event_metadata_packet.h
src/nx/sdk/analytics/i_object_metadata_packet.hand the general helpers under src/nx/sdk/helpers/ are there too. It's specifically the analytics/helpers/ wrappers that are absent.
What I've tried
- Verified the extracted archive is complete and searched the whole SDK tree for
analytics/helpers— no match - Confirmed
NX_PLUGIN_APIis defined in my CMake target (that resolved a separate C1189) - Implementing the raw
IEngine/IDeviceAgentinterfaces directly instead — workable, but the helper classes handle the metadata packet plumbing and I'd rather not reimplement them if they're available
-
Thanks for your question. I've double-checked, and the Server Plugin SDK itself is correct no changes/missing found there.
I suspect the files you have may be incorrect or incomplete, possibly due to a download issue. Could you let us know where you downloaded them from?
For reference, I've re-verified the download link on both our end and public. The files are exactly same one, also the Analytics Help files are in the correct location and working as expected.
0 -
Hi Vivek Maturkar / Ichiro,
I'm also having the same issue. It appears that the
sdk/analytics/helpers/plugin.hfile is missing in the Server Plugin SDK. I suspect that the old plugin samples are referring to an older SDK, and theplugin.hfile is actually nowsdk/analytics/helpers/integration.h?
I believe this may have been renamed due the terminology changes (pluginbeing the legacy terminology, andintegrationbeing the updated terminology)?Please confirm.
See: Important Note on Terminology:
https://support.networkoptix.com/hc/en-us/articles/32919821638039-Introduction-into-Creating-a-Video-Analytics-Integration0 -
Hi,
Thanks for the questions, happy to clear this up.
The term "plugin" became "integration" as of v6.1.0 (released 1 Dec 2025). Within the SDK, “plugin” is kept only as a fallback for early integrations that were built against it for the binary.

For anything implemented on the 6.1.0 SDK or later, the new integration.h is the one to use, and plugin.h should be dropped. As you may notice, the samples in the 6.1.2 SDK resources reference integration.h only. So my main suggestion would be to update to the latest SDK version, which should resolve this on its own immediately.
This change has been in the release notes, so maybe download the latest SDK(download link) confirm the details, and see if that helps.
0 -
Thanks for confirming Ichiro.
It looks like the samples that are bundled with the SDK (the downloadable zip) reference the latestintegration.h, but the samples in thenx_open_integrationsgit repo still refer to the olderplugin.h, hence the build errors when used with the latest SDK.
e.g.
https://github.com/networkoptix/nx_open_integrations/blob/master/cpp/vms_server_plugins/opencv_object_detection_analytics_plugin/step1/src/nx/vms_server_plugins/analytics/sample/engine.h
I ended up basing my code off the samples that are bundled with the SDK, and everything is working fine now.0
Please sign in to leave a comment.
Comments
4 comments