ACAP 3.4
API Main Page

AXIS Embedded Development SDK provides the following interfaces, please note some APIs are product specific.

Video and audio APIs

Management APIs

Camera feature APIs

API versions

The table below shows API and firmware version compatibility .

API version firmware version
API 3.0 FW 9.70
API 3.1 FW 9.80
API 3.2 FW 10.2
API 3.3 FW 10.5
API 3.4 FW 10.6

Video & Audio Interfaces

Audio Interface

Ax_Audio documentation

Allows the application to retrieve compressed/uncompressed audio in different formats​ from the camera and sending uncompressed audio to the cameras that have an audio output. Some of the compressed formats can also be configured with different sample rates and with different bitrates. API supports a lot of get methods to find out more about the formats that are supported on the camera that is being used.

The API supports products with the following chips:

  • ARTPEC 7.
  • ARTPEC 6.
  • Ambarella S5L.
  • Ambarella S5.
  • Ambarella S2L.

Video Stream Interface

Vdostream documentation

For image and video porcessing.

The VdoStream API provides:

  • video and image stream.
  • video and image capture.
  • video and image configuration.
Warning
The API is not supported for S2L based products.

Machine learning API

Larod documentation

liblarod lets you communicate with the Larod machine learning service, and use its features. The Machine learning API can be used for deep learning applications.

The API supports products with the following chips:

  • ARTPEC 7.
  • Ambarella S5L.
Note
For products with a DLPU (Deep Learning Processing Unit), inference runs on the DLPU otherwise it runs on the CPU.

Version history

API version ACAP version Description
1.0 3.1 Larod API introduced
2.0 3.3 • Preprocessing functionality • Handles TFLite when using firmware version 1 0.6 and later.
Note
We recommend using Larod version 2.0. However you can still use Larod version 1.0. T o use Larod 1.0, define LAROD_API_VERSION_1 in your application, see Backward compatibility in Introduction to larod for app developers for more information.

Overlay Interface

Ax_Overlay documentation

Overlay is a helper library to enable ACAP draw overlays in selected video streams.

Has built-in support for Cairo as rendering API and it has open backend for any other custom rendering API Supports ARTPEC-6 and ARTPEC-7 and hide chip differences.


Supported Open Source APIs and libraries

  • Cairo

Cairo 1.16.0.
Supports ARTPEC-6 and ARTPEC-7.
Is an Open-source rendering library for 2D vector graphics.
Can be used together with Axoverlay.
Common use-cases, rendering texts for internal text overlays. Rendering lines, bounding boxes or any vector shapes and Loading SVG.
See Cairo documentation.

  • OpenGL ES

OpenGL ES 2.0 support ARTPEC-6 & ARTPEC-7.
Accelerate graphics rendering with GPU Common use-cases, rendering mask for Axis Live Privacy Shield.
Rendering GUI for door camera with display information as PTZ or a street name.
See OpenGL ES documentation.

  • OpenCL

OpenCL 1.2.
Supports ARTPEC-7.
Accelerate parallel compute with GPU.
Common use-cases, colour conversion (e.g. as pre-processing for DL and analytics), Audio filter and Accelerates OpenCV.
See OpenCL documentation.

  • OpenVX

OpenVX 1.0.
Supports ARTPEC-7.
Accelerate computer vision with GPU.
Common use-cases, perspective transform (e.g. as pre-processing for DL and analytics). Non real-time DL.
See OpenVX documentation.

Attention
Cairo, OpenGL, OpenCL and OpenVX are an open source libraries.
AXIS DOES NOT PROVIDE SUPPORT OF ANY KIND,UNLESS AXIS SPECIFIES OTHERWISE.

Capture Interfaces

Media Capture documentation

Allows the application to retrieve compressed images in JPEG format​ from the camera. Image parameters such as resolution and rotation​ for the captured images can be specified. Depending on the major version of the library, you may also retrieve uncompressed raw formats.

Attention
This is a legacy API, the support for it has been removed in the latest version, in favour for the VDO interface for video capture.

Management Interfaces

Parameter Interface

Ax_Parameter documentation

The AXParameter interface enables data and application settings to be saved so that they are not lost during a reboot or firmware upgrade of the Axis product. Parameters specific to the application can be preconfigured when the application is created or be added in runtime. In addition, AXParameter makes it possible to define callback functions that perform specific actions if a parameter is updated, for example if the user updates a parameter using the Axis product's web pages. Data which only is used and altered by the application should not be handled by AXParameter. Such data can instead be handled by, for example, GLib GKeyFile.

HTTP Interface

Ax_HTTP documentation

Allows the application to act as a CGI. This is done through a socket transfer to the ACAP application. This is a useful way to provide configuration API, or provide updated information from the ACAP application, for a configuration page provided with the ACAP application, accessible from ACA.

Event Interface

Ax_Event documentation

The axevent library provides an interface to the event system found in Axis devices. AXEvents library provides applications with a mechanism for sending and receiving events. An application can both send and receive events.

License Interface

License key documentation

Ensures that the application can only run if it has a valid license key. To use license keys, an application ID and license code must be retrieved from Axis. The license codes are intended to be sold to end customers. To run a licensed application, the end user registers the license code together with the unique serial number of the Axis product. When the registration is complete, the user receives a license key which is valid only for the specified application and Axis product. The application will not run until the license key is uploaded to the product.​


Camera feature Interfaces

Edge Storage Interface

Ax_Storage documentation

Allows the application to save and retrieve data on mounted storage devices such as SD cards and NAS (Network Attached Storage) units. An application can only modify its own files on the storage device.

Serial Port Interface

Ax_SerialPort documentation

The AxSerialPort API allows the application to configure and control the external serial port on selected Axis products. This API is product dependent since not all Axis products are equipped with a serial port. The API supports the RS-232, RS-422 and RS-485 standard.

Pan Tilt Zoom Interface

Ax_PTZ documentation

Allows the application to control the camera's pan, tilt and zoom movements, to interact with the PTZ control queue and to create and delete preset positions.