Version: ACAP version 12

This document is automatically generated from manifest schema

Field descriptions

All fields that are not marked as Required are optional

$schema string

URI of the manifest schema for validation
schemaVersion string Required

Specifies the application manifest schema version using three dot-separated integer numbers, which follow the semantic versioning rules for MAJOR, MINOR and PATCH version numbers.
resources object

Host resources the application requires access to.
- dbus object
  
  D-Bus resources on the host system that the application requires or desires access to.
  - requiredMethods array
    
    A list of D-Bus methods (given as strings) that are required by the application to be part of an API of the host system. If the methods are not present, the application is considered incompatible and will be rejected at installation. A wildcard '*' can be supplied at the end of a string, preceeded by a dot '.', to match all methods of a D-Bus interface.
  - conditionalMethods array
    
    A list of D-Bus methods (given as strings) desired by the application that may or may not be part of an API of the host system. If the methods are not present the application will still be installed. It is up to the application to handle the absence of the methods appropriately. A wildcard '*' can be supplied at the end of a string, preceeded by a dot '.', to match all methods of a D-Bus interface.
- deepLearningProcessor object
  
  Specifies if the application requires or desires access to the Deep Learning Processing Unit (DLPU).
  - enabled boolean Required
    
    Enables DLPU access, if available.
  - required boolean Required
    
    If set to true, installation fails when DLPU access is not available. If set to false, installation proceeds regardless.
- linux object
  
  Linux resources on the host system that the application requires or desires access to.
  - user object
    
    Dynamic user the application shall run as. The username of the dynamic user is determined at installation. If the application requires knowledge of the username it shall use the underlying OS functions to read it. Only one of dynamic user and static user (see acapPackageConf > setup > user) may be specified.
    - groups array
      
      A list of secondary groups (given as strings) the application user should belong to.
    - conditionalGroups array
      
      A list of secondary groups (given as strings) the application user will belong to, if they exist and are allowed. It is up to the application to handle if the application user was not granted membership to one or more conditional groups.
- deviceDataHub_beta2 object
  
  Access to Device Data Hub for this ACAP application
  - enabled boolean Required
    
    Enables Device Data Hub for this ACAP application
  - accessControlList array
    
    A list of entries that specify access rights
    
    An entry that specifies access rights
    - topics array Required
      
      A list of absolute topics in reverse domain format. The reverse domain prefix requires at least two segments (e.g. com.example), followed by at least one topic-specific segment. Topics starting with com.axis or containing wildcards (+ and #) are not allowed.
    - usernames array Required
      
      A list of users
    - operations array Required
      
      A list of operations that are valid on the specified topics for the specified users
- overlay object
  
  Access to overlay
  - enabled boolean Required
    
    Enables overlay, if available.
  - required boolean
    
    Fails installation if overlay is not available.
acapPackageConf object Required

An ACAP package configuration object.
- setup object Required
  
  ACAP application identification and information settings.
  - appName string Required
    
    Name of the executable file.
  - appId string
    
    Application ID (provided by Axis). To retrieve an application ID, contact the Axis Technology Integration Partner Program support
  - architecture string Required
    
    The target architecture(s) that the ACAP application supports. Will be set at build time if missing. Possible values: all, aarch64, armv7hf
  - compatibleOsVersions array Required
    
    A list of version ranges of AXIS OS that this application has been designed to be compatible with. Starting with AXIS OS 12.10, the application will be prevented from being installed on devices with an AXIS OS version not within any of these ranges.
    
    AXIS OS version range
    - min string Required
      
      Minimum version in this range. If only major version is given, the range includes all minor versions within that major version. If patch version is omitted, the range includes all patch versions within that minor version. If omitted, the SDK will automatically set it to the minimum AXIS OS version it supports, starting with ACAP SDK 12.10.
    - max string Required
      
      Maximum version in this range. If only major version is given, the range includes all minor versions within that major version. If patch version is omitted, the range includes all patch versions within that minor version.
  - friendlyName string
    
    User-friendly package name. The name that will be displayed e.g. in the embedded web pages.
  - user object
    
    Static user and group the application shall run as. Only one of dynamic user (see resources > linux > user) and static user may be specified.
    - username string Required
      
      Name of a user already existing on the device, used for application execution and file ownership. Possible values: sdk
    - group string Required
      
      Name of a user group already existing on the device, used for application execution. Possible values: admin, audiod, gpu, hidraw, operator, pipewire, ptzadm, sdk, storage, video, viewer
  - runMode string Required
    
    'once' means the application will be started at boot. 'respawn' means the application will be started at boot and restarted if it exits. 'respawnOnFailure' means the application will be started at boot and restarted if it exits with a non-zero exit code. 'never' means the application will never be started automatically, only through a VAPIX request. Possible values: once, respawn, respawnOnFailure, never
  - runOptions string
    
    Optional application command line options
  - vendor string Required
    
    The company name of the provider and maintainer of the ACAP application.
  - vendorUrl string
    
    Link to the vendor home page.
  - vendorId string Required
    
    The unique identifier of the provider and maintainer of the ACAP application.
  - version string Required
    
    The ACAP application version, following the semantic versioning rules.
- installation object
  
  ACAP application installation settings
  - postInstallScript string
    
    Optional script that will be run on the Axis product after ACAP package installation completion. This must be a shell script located in the package root.
- uninstallation object
  
  ACAP application uninstallation settings
  - preUninstallScript string
    
    Optional script that will be run on the Axis product before uninstallation of the ACAP. This must be a shell script located in the package root.
- configuration object
  
  ACAP application interaction setup.
  - settingPage string
    
    The name of the main embedded web page of the ACAP application. To be refered to when listing installed ACAP applications. Must be located in directory 'html' relative to application package root.
  - httpConfig array
    
    A list of web server configuration objects.
    
    A web server CGI configuration object.
    - type string Required
      
      CGI implementation type. Possible values: transferCgi, fastCgi
    - name string Required
      
      CGI path relative to application web root.
    - access string Required
      
      Access policy for calling the CGI. Possible values: admin, operator, viewer
    A web content object.
    - type string Required
      
      Type of ACAP application web content. The type refers to the 'html' directory in the application package root. Possible values: directory
    - access string Required
      
      Access policy for viewing ACAP application web content, i.e. all files that are stored under 'html' directory in the application package root. Default access policy is 'admin'. Be aware that changing access policies will give general access to the web content. Possible values: admin, operator, viewer
  - paramConfig array
    
    A list of parameter configuration objects. It is possible to interact with these parameters using the Parameter API (axparameter), the VAPIX API or from the settings web page of the ACAP application.
    
    A parameter object.
    - name string Required
      
      Name of the parameter.
    - default string Required
      
      Parameter default value.
    - type string Required
      
      Parameter type definition string.
  - reverseProxy array
    
    A list of reverse proxy configuration objects.
    
    A reverse proxy unix domain socket object.
    - apiPath string Required
      
      API path relative to the ACAP application home path.
    - apiType string Required
      
      API protocol (http, web socket or fast cgi). Possible values: http, ws, fcgi
    - target string Required
      
      Target path to a unix domain socket.
    - access string Required
      
      Access policy for calling the path. Possible values: admin, operator, viewer, anonymous
    A reverse proxy tcp object.
    - apiPath string Required
      
      API path relative to the ACAP application home path.
    - target string Required
      
      Target path. FastCGI or URI (http or web socket).
    - access string Required
      
      Access policy for calling the path. Possible values: admin, operator, viewer, anonymous
- copyProtection object
  
  ACAP application copy protection utilization
  - method string Required
    
    Copy protection mechanism. If 'axis', appId property must be set, as appId is required for the Axis license. Possible values: none, axis, custom