Merge pull request #123 from AxisCommunications/sync-20240304-1

sync 20240304 1

Author: pataxis

Gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org/"
 # here are only used for local development. Update the versions when needed to
 # match GitHub Pages, see https://pages.github.com/versions for more info.
 gem "github-pages", "~> 228"
-gem "just-the-docs", "~> 0.7.0"
+gem "just-the-docs", "~> 0.8.0"

assets/images/vs-code-manifest-validation1-500x500.png

@@ -2,12 +2,13 @@
 layout: acap_sdk_version_3
 parent: Develop applications
 grand_parent: ACAP SDK version 3
-title: VAPIX access for ACAP applications - BETA
+title: VAPIX access for ACAP applications
 nav_order: 4
 ---
-# VAPIX access for ACAP applications - BETA
+# VAPIX access for ACAP applications
 
 From AXIS OS 11.6, ACAP applications can acquire VAPIX service account credentials in runtime. With these credentials, the ACAP application can call a local virtual host to make VAPIX requests on the device. A username and a password with high complexity are created for every credential acquisition. These credentials are only valid on the local virtual host (127.0.0.12) and aren't stored in any file. It should only be kept in memory by the ACAP application.
+You can jump to the [Vapix](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/vapix) example or follow this guide for a more detailed walkthrough.
 
 The following steps show how to get VAPIX credentials in an ACAP application.
 

docs/acap-sdk-version-3/develop-applications/vapix-access-for-acap-applications.md

@@ -111,7 +111,17 @@ replace_acap3_button() {
 #-------------------------------------------------------------------------------
 
 # Release settings
-apis="axevent axoverlay axserialport axstorage larod licensekey vdostream"
+apis="\
+  axevent \
+  axoverlay \
+  axparameter \
+  axserialport \
+  axstorage \
+  larod \
+  licensekey \
+  metadata-broker \
+  vdostream \
+"
 
 # Version strings
 apiver_minor="${apiver#*.}"

docs/api/_setup_apidocs.sh

@@ -25,3 +25,8 @@ or in the Beta API example if there is one available.
 
 Feedback on the service and API can be given in the [ACAP Computer Vision SDK
 examples](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/issues) issue tracker.
+
+### Metadata Broker API
+
+Feedback on the service and API can be given in the [ACAP Native SDK
+examples](https://github.com/AxisCommunications/acap-native-sdk-examples/issues) issue tracker

docs/api/beta-api.md

@@ -9,16 +9,19 @@ nav_order: 1
 
 The ACAP Native SDK provides the following APIs:
 
+<!-- markdownlint-disable MD033 -->
 - [Video capture API (VDO)](#video-capture-api-vdo)
 - [Machine learning API (Larod)](#machine-learning-api-larod)
 - [Overlay API](#overlay-api)
 - [Cairo](#cairo)
 - [OpenCL](#opencl)
+- [Parameter API](#parameter-api)
 - [Event API](#event-api)
 - [Edge storage API](#edge-storage-api)
 - [License Key API](#license-key-api)
 - [FastCGI](#fastcgi)
 - [Serial port API](#serial-port-api)
+- [Metadata Broker API](#metadata-broker-api) <a class="label label-blue">BETA</a>
 
 ## Compatibility
 
@@ -187,6 +190,74 @@ The OpenCL 1.2 was introduced in Native SDK 1.0.
 - [vdo-opencl-filtering](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/vdo-opencl-filtering/)
   - This example illustrates how to capture frames from the vdo service, access the received buffer, and finally perform a GPU accelerated Sobel filtering with OpenCL.
 
+## Parameter API
+
+Go to the [ACAP API Documentation](src/api/axparameter/html/index.html) for
+detailed functional descriptions of this API.
+
+The AXParameter C library provides the following functionality:
+
+- Read and modify **application parameters** stated in `manifest.json`.
+- Add and remove **application parameters** in C code, in addition to the ones
+  already defined in `manifest.json`.
+- Set up **callbacks** so the application can act immediately on changes made
+  to the **application parameters** via the
+  [application settings web page](#application-settings-web-page) or VAPIX.
+- Read **system parameters**.
+
+**Application parameters** have the following properties:
+
+- They are preserved when an application is restarted or upgraded.
+- They are preserved when the device is restarted and when firmware is upgraded.
+- They are displayed and possible to set in the
+  [application settings web page](#application-settings-web-page).
+- They can be read and modified using VAPIX API
+  [param.cgi](https://www.axis.com/vapix-library/subjects/t10175981/section/t10036014/display).
+
+> The application parameters are **not private** to the application, they can
+> be:
+>
+> - *read* via VAPIX by a user with `operator` privileges.
+> - *read* and *modified* via VAPIX by a user with `admin` privileges.
+> - *read* and *modified* by another application if the application users belongs
+>   to the same group.
+
+### Application settings web page
+
+The application settings web page can be used to modify **application
+parameters**.
+
+In the Axis device web page:
+
+- Go to *Apps* tab
+- Open the application options
+- Click *Settings* to open a dialog where parameters can be set
+
+Note that a reload of the web page is required to display values set from C code
+or VAPIX.
+
+### Compatibility
+
+The Parameter API supports products with the following chips:
+
+- ARTPEC-8
+- ARTPEC-7
+- ARTPEC-6
+- Ambarella CV25
+- Ambarella S5L
+- Ambarella S5
+- i.MX 6SoloX
+- i.MX 6ULL
+
+### Version history
+
+The Parameter API was introduced in Native SDK 1.13.
+
+### Code Examples
+
+- [axparamter](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/axparamter)
+  - An example in C that demonstrates how to manage application-defined parameters, allowing you to add, remove, set, get, and register callback functions for parameter value updates.
+
 ## Event API
 
 Go to the [ACAP API Documentation](src/api/axevent/html/index.html) for detailed functional descriptions of this API.
@@ -358,3 +429,33 @@ The Serial port API was introduced in Native SDK 1.11.
     - Enabling the serial port.
     - Configuring parameters using the API.
     - Establishing communication between two available ports in the Axis product using GLib IOChannel methods.
+
+## Metadata Broker API
+
+> This API is a [Beta version](./beta-api) and developers are encouraged to test and leave feedback.
+
+Go to the [ACAP API Documentation](src/api/metadata-broker/html/index.html) for detailed
+functional descriptions of this API.
+
+The Metadata Broker API allows an ACAP application to consume metadata from
+a producer in AXIS OS by subscribing to a `topic`.
+
+The API implements the Publish/Subscribe messaging paradigm.
+
+### Compatibility
+
+The Metadata Broker API supports products with the following chips:
+
+- ARTPEC-8
+- ARTPEC-7
+- Ambarella CV25
+
+### Version history
+
+The Metadata Broker API was introduced in Native SDK 1.13.
+
+### Code Examples
+
+- [analytics-scene-description-example](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/metadata-broker/consume-analytics-scene-description)
+  - The example is written in C and shows how to consume metadata stream
+    **Analytics Scene Description**.

docs/api/native-sdk-api.md

@@ -1,9 +1,9 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>AXEvent: ax_event.h File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -13,9 +13,6 @@
 <script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
-<script type="text/javascript">
-  $(document).ready(initResizable);
-</script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
 </head>
@@ -35,14 +32,15 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
+<!-- Generated by Doxygen 1.9.1 -->
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
 $(function() {
   initMenu('',false,false,'search.php','Search');
 });
-</script>
+/* @license-end */</script>
 <div id="main-nav"></div>
 </div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -56,7 +54,9 @@
   </div>
 </div>
 <script type="text/javascript">
-$(document).ready(function(){initNavTree('ax__event_8h.html','');});
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('ax__event_8h.html',''); initResizable(); });
+/* @license-end */
 </script>
 <div id="doc-content">
 <div class="header">
@@ -84,19 +84,19 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:a49ef3926134d564b32e976d7d7576c81"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ax__event_8h.html#a49ef3926134d564b32e976d7d7576c81">__attribute__</a> ((deprecated)) <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33">AXEvent</a> *ax_event_new(<a class="el" href="ax__event__key__value__set_8h.html#a1c3eb1e83ed9837e00682a8d3f1ac2e0">AXEventKeyValueSet</a> *key_value_set</td></tr>
-<tr class="memdesc:a49ef3926134d564b32e976d7d7576c81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events. ">AXEvent</a>.  <a href="#a49ef3926134d564b32e976d7d7576c81">More...</a><br /></td></tr>
+<tr class="memdesc:a49ef3926134d564b32e976d7d7576c81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events.">AXEvent</a>.  <a href="ax__event_8h.html#a49ef3926134d564b32e976d7d7576c81">More...</a><br /></td></tr>
 <tr class="separator:a49ef3926134d564b32e976d7d7576c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a788775473fa91f3503b42616c7626e2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33">AXEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ax__event_8h.html#a788775473fa91f3503b42616c7626e2b">ax_event_new2</a> (<a class="el" href="ax__event__key__value__set_8h.html#a1c3eb1e83ed9837e00682a8d3f1ac2e0">AXEventKeyValueSet</a> *key_value_set, GDateTime *time_stamp)</td></tr>
-<tr class="memdesc:a788775473fa91f3503b42616c7626e2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events. ">AXEvent</a>.  <a href="#a788775473fa91f3503b42616c7626e2b">More...</a><br /></td></tr>
+<tr class="memdesc:a788775473fa91f3503b42616c7626e2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events.">AXEvent</a>.  <a href="ax__event_8h.html#a788775473fa91f3503b42616c7626e2b">More...</a><br /></td></tr>
 <tr class="separator:a788775473fa91f3503b42616c7626e2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a011c2d3b82c8e9cbcf0fab02610a5020"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ax__event_8h.html#a011c2d3b82c8e9cbcf0fab02610a5020">ax_event_free</a> (<a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33">AXEvent</a> *event)</td></tr>
-<tr class="memdesc:a011c2d3b82c8e9cbcf0fab02610a5020"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an <code>AXEvent</code>.  <a href="#a011c2d3b82c8e9cbcf0fab02610a5020">More...</a><br /></td></tr>
+<tr class="memdesc:a011c2d3b82c8e9cbcf0fab02610a5020"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an <code>AXEvent</code>.  <a href="ax__event_8h.html#a011c2d3b82c8e9cbcf0fab02610a5020">More...</a><br /></td></tr>
 <tr class="separator:a011c2d3b82c8e9cbcf0fab02610a5020"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abc27a691c703d11563ef0b0f338fc775"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="ax__event__key__value__set_8h.html#a1c3eb1e83ed9837e00682a8d3f1ac2e0">AXEventKeyValueSet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ax__event_8h.html#abc27a691c703d11563ef0b0f338fc775">ax_event_get_key_value_set</a> (<a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33">AXEvent</a> *event)</td></tr>
-<tr class="memdesc:abc27a691c703d11563ef0b0f338fc775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <code>AXEventKeyValueSet</code> associated with the <code>AXEvent</code>.  <a href="#abc27a691c703d11563ef0b0f338fc775">More...</a><br /></td></tr>
+<tr class="memdesc:abc27a691c703d11563ef0b0f338fc775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <code>AXEventKeyValueSet</code> associated with the <code>AXEvent</code>.  <a href="ax__event_8h.html#abc27a691c703d11563ef0b0f338fc775">More...</a><br /></td></tr>
 <tr class="separator:abc27a691c703d11563ef0b0f338fc775"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a37fcd4106a9ed74e315bbbec24c941fa"><td class="memItemLeft" align="right" valign="top">GDateTime *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ax__event_8h.html#a37fcd4106a9ed74e315bbbec24c941fa">ax_event_get_time_stamp2</a> (<a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33">AXEvent</a> *event)</td></tr>
-<tr class="memdesc:a37fcd4106a9ed74e315bbbec24c941fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the time stamp associated with the <code>AXEvent</code>.  <a href="#a37fcd4106a9ed74e315bbbec24c941fa">More...</a><br /></td></tr>
+<tr class="memdesc:a37fcd4106a9ed74e315bbbec24c941fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the time stamp associated with the <code>AXEvent</code>.  <a href="ax__event_8h.html#a37fcd4106a9ed74e315bbbec24c941fa">More...</a><br /></td></tr>
 <tr class="separator:a37fcd4106a9ed74e315bbbec24c941fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
@@ -128,7 +128,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a49ef3926134d564b32e976d7
       </table>
 </div><div class="memdoc">
 
-<p>Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events. ">AXEvent</a>. </p>
+<p>Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events.">AXEvent</a>. </p>
 <p>Get the time stamp associated with the <code>AXEvent</code>.</p>
 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>This function has been deprecated. Use ax_event_new2 instead.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
@@ -176,7 +176,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a788775473fa91f3503b42616
       </table>
 </div><div class="memdoc">
 
-<p>Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events. ">AXEvent</a>. </p>
+<p>Creates a new <a class="el" href="ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33" title="The AXEvent is an opaque data type required to send and receive events.">AXEvent</a>. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">key_value_set</td><td>An <code>AXEventKeyValueSet</code>. </td></tr>
@@ -211,8 +211,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a011c2d3b82c8e9cbcf0fab02
   </table>
   </dd>
 </dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="ax_event_subscription_example_8c-example.html#a3">ax_event_subscription_example.c</a>.</dd>
+<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="ax_event_subscription_example_8c-example.html#a3">ax_event_subscription_example.c</a>.</dd>
 </dl>
+
 </div>
 </div>
 <a id="abc27a691c703d11563ef0b0f338fc775"></a>
@@ -239,8 +240,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#abc27a691c703d11563ef0b0f
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The <code>AXEventKeyValueSet</code> associated with the <code>AXEvent</code>. </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="ax_event_subscription_example_8c-example.html#a0">ax_event_subscription_example.c</a>.</dd>
+<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="ax_event_subscription_example_8c-example.html#a0">ax_event_subscription_example.c</a>.</dd>
 </dl>
+
 </div>
 </div>
 <a id="a37fcd4106a9ed74e315bbbec24c941fa"></a>