Ayonix Video Analytics

Developers

Video analytics SDK: what to expect from an evaluation

In short

Ayonix does not publish a public SDK reference. This page explains what an SDK integration involves, what your team should prepare before an evaluation, and how to request access. Concrete class names, method signatures and build instructions are supplied by Ayonix under an evaluation agreement.

Scope

What is on this page, and what needs access

Published here

  • The integration patterns an analytics SDK supports: stream ingestion, detection, rule evaluation and event emission
  • What your team needs to prepare before an evaluation begins
  • How evaluation access is requested and what it typically includes
  • The architectural questions that determine whether SDK integration or a VMS plugin is the right route

Requires evaluation access

  • Class names, method signatures and language bindings
  • Build, packaging and deployment instructions
  • Licensing model and runtime licensing mechanism
  • Supported platforms, accelerator requirements and performance characteristics
  • Sample code and reference implementations

No endpoint path, class name, method signature or response shape appears anywhere on these pages. Ayonix does not publish a public interface specification, and documenting an invented one would waste your engineering time building against a contract that does not exist.

When SDK integration is the right route

Most customers do not need the SDK. If the goal is analytics events inside an existing VMS, a VMS integration is a shorter path with less to maintain. The SDK route makes sense when analytics must be embedded in a product or platform you build and operate yourself.

  • You are building a product that embeds video analytics rather than deploying one
  • Your platform is not a VMS and needs analytics as a component rather than a system
  • You need to control the processing lifecycle, scheduling or hardware allocation directly
  • A VMS integration or webhook delivery has been evaluated and genuinely does not fit

What to prepare before an evaluation

Evaluations go substantially faster when the technical context is ready. Most delays come from camera and environment questions rather than from the SDK itself.

  • A representative camera inventory with resolution, codec and frame rate per stream
  • Target platform and available hardware, including any accelerator
  • The specific analytics capabilities in scope, from the published capability set
  • Expected event volume and how events will be consumed downstream
  • Deployment model — edge, on-premise or air-gapped — since it constrains packaging
  • Any data-residency or security constraint that affects where code and video may run

Authentication and licensing principles

Any SDK integration carries a licensing mechanism and, where applicable, credentials. The principles below apply regardless of the specific mechanism Ayonix supplies.

  • Licence material and credentials belong in server-side or device-side secure storage, never in client code
  • Air-gapped deployments require an offline licensing path — confirm this early if it applies
  • Credential rotation should be designed in rather than added after deployment
  • Licence state should be observable in health monitoring so expiry never surfaces as an unexplained outage

Versioning and compatibility

Embedding analytics in your own product means taking on the version compatibility question. Agree the policy before you build against a version.

  • Establish the supported-version window and the deprecation notice period in writing
  • Pin a version in your build rather than tracking the latest automatically
  • Test upgrades against a representative stream set, because detection behaviour can shift between versions
  • Keep the ability to roll back to the previous version in production

Frequently asked questions

Where can I download the SDK?

It is not publicly downloadable. Access is arranged with Ayonix under an evaluation agreement, which is also when you receive the interface documentation, licensing details and supported-platform information.

Why does this page contain no code examples?

Because the interface is private and has not been verified from a public specification. Publishing invented class names or method signatures would produce documentation that looks authoritative and cannot be built against, which is worse than publishing none.

Should we use the SDK or a VMS integration?

If analytics events need to reach operators in an existing VMS, the VMS route is almost always shorter and cheaper to maintain. The SDK route is for embedding analytics in a product or platform you build and operate yourself.

Other developer pages

Author
Gabriel Bamola, Chief Marketing Officer, Ayonix
Technical review
Dr Sadi Vural, Founder and Chief Executive Officer, Ayonix
Published
Last reviewed

Request evaluation access

Evaluation access includes the interface documentation, licensing details and supported-platform information that this site deliberately does not publish. Tell us what you are building and an engineer will scope it with you.

Request SDK evaluation access Read the architecture guidance