JSON File Schema - JSON File Schema - 6.3 English

JSON File Schema - JSON File Schema - 6.3 English - XD056

Vitis Video Analytics SDK (VVAS) 6.3 User Guide (XD056)

Document_ID

XD056

Release_Date

2026-09-24

Version

6.3 English

The configuration file used in VVAS Infrastructure plug-ins has to be defined in a JSON format. This section defines the schema for the configuration files.

Table 31 Root JSON Object Members
JSONKey	ValueType	Mandatory or Optional	Default Value	Description
xclbin -location	String	Optional	NULL	Location of the xclbin to program the FPGA.
vvas-library -repo	String	Optional	/usr/lib	The VVAS library repository path that looks for the acceleration software libraries using the VVAS GStreamer plug-in.
element-mode	String	Mandatory		The GStreamer uses the element mode to operate. Based on your requirements, you must choose one of the following modes: Passthrough: In this mode, the element does not alter the input buffer. Inplace: In this mode, the element alters the input buffer instead of producing new output buffers. Transform: In this mode, the element produces an output buffer for each input buffer.
kernel	Kernel JSON Object	Mandatory	None	A kernel JSON object provides information about a VVAS video library configuration. For information on object members, see Kernel JSON Object Members.

Table 32 Kernel JSON Object Members
JSONKey	ValueType	Mandatory or Optional	Default Value	Description
library-name	String	Mandatory	None	The name of the VVAS video library loaded by the VVAS GStreamer plug-ins. The absolute path of the video library is formed by prepending the `vvas-library-repo` path.
kernel-name	String	Optional	None	The name of the IP or kernel in the form of <kernel name>:<instance name>.
kernel-access -mode	String	Optional	shared	Mode in which the IP/kernel is to be accessed. “shared” or “exclusive” .
config	Object	Optional	None	Holds the configuration specific to the VVAS video library. The VVAS GStreamer plug-ins do not parse this JSON object; instead, it is sent to the video library.