March 25, 2024

REQUIRED_OBJECTS

This element contains a list of objects that should not be stripped at build time even if they are not used by the current skin. Can be used for testing purposes, or when using a KUIML_WIDGET. Multiple instances of this element are allowed: any new object identifier will be added to the list of required objects.

Attributes brief detailed show all inherited

	Name	Description
	object_ids	List of identifiers of objects to be declared as required

	Name	Value type	Default	Description	Comment
	object_ids	';' separated identifiers	empty	List of identifiers of objects to be declared as required

Examples

<REQUIRED_OBJECTS object_ids="dsp.input1.BeginCapture;dsp.input1.EndCapture" />

Explanation

Say you've declared a param in the main skin (.xml) file:

<PARAM id="my_param" min="0" max="100" default="0" />

You plan to use this parameter inside the KUIML_WIDGET. If you've never used this parameter inside the main skin (where it was declared), then it will be stripped (not created) by the KUIML engine, and so inside KUIML_WIDGET you'll get an error saying that this parameter is missing. To prevent this, you can use REQUIRED_OBJECTS in the main skin (where my_param is declared):

<REQUIRED_OBJECTS object_ids="my_param" />

Now that parameter is created in the data model and not stripped even if it's not used in the current skin.

To make this parameter accessible in other data models (say in KUIML_WIDGET) and scripts see EXPOSED_OBJECTS.