Device description file: Defining an object

<Object>

Name ID / Addr Type Def Tmp Incl Description
Type ID / Add Attribute 0..1 0 ..1

This attribute is optional. DynamicObject is the default value.

Possible values:

  • DynamicObject
  • BiquadCoefficientsObject
Key ID / Add Attribute 1 Unique key to identify the object template.
Template ID / Add Attribute 1 Key to the object template.
Name ID / Add Attribute 1 1 Name of the Object.
HiQnetAddr ID / Add Attribute 0 .. 1 0 .. 1 HiQnet Addr of the object. Either <HiQnetAddr> or <HiQnetOffset> must be present. Format: xxx.yyy.zzz
HiQnetOffset ID / Add Attribute 0 .. 1 0 .. 1 HiQnet Addr is an offset of the object relative to the parent object HiQnet Addr. Either <HiQnetAddr> or <HiQnetOffset> must be present.
TargetDevice Add Attribute 0 .. 1 0 .. 1 Index of the target device. If not present, the device index is inherited from the parent object. It can be a decimal (15) or a hexadecimal (0x0F).
TargetAddr Add Attribute 0 .. 1 0 .. 1 Base Addr of the target device. Either <TargetAddr> or <Offset> must be present. It can be a decimal (10944) or a hexadecimal (0x2AC0).
TargetOffset ID / Add Attribute 0 .. 1 0 .. 1 Addr offset of the target device relative to the parent object. Either <TargetAddr> or <Offset> must be present. It can be a decimal (10944) or a hexadecimal (0x2AC0).
Core ID Attribute 0 .. 1 0 .. 1 Core index of the target device. At least one parent of the Object must specify the core ID. Core ID is inherited from the parent Object.
Instance ID Attribute 0 .. 1 0 .. 1 xAF instance index of the target device. At least one parent of the Object must specify the xAF instance ID. The Instance ID is inherited from the parent Object.
BlockID ID Attribute 0 .. 1 0 .. 1 ID of the audio processing block including sub-block ID. Format: xxx.yyy.zzz (xxx is MSB of block ID, yyy is LSB of block ID, zzz is sub-block ID).  A given blockID should only be defined once, and contain a category definition for that subblock.
IDOffset ID Attribute 0 .. 1 0 .. 1 Offset is added to the BlockID of the parent object to get the block ID of the current audio block. Either <BlockID> or <IDOffset> must be present. It can be a decimal (10944) or a hexadecimal (0x2AC0).
<ExplorerIcon> ID / Add Element 1 1 Icon that is displayed in the tree. Possible values:

  • Object
  • VD
  • NodeManager
  • Input
  • GEQ
  • PEQ
  • Notch
  • Delay
  • Compressor
  • Limiter
  • Gate
  • AGC
  • AFS
  • SubharmonicSynth
  • Autowarmth
  • BPF
  • XOver
  • Deesser
  • Mixer
  • Router
  • Meters
  • RTA
  • Output
<TargetValues> ID / Add Element 0 .. 1 0 ..1 List of target values, which are only valid for objects that are not default objects (objects that are not DynamicObjects).
<StateVariables> ID / Add Element 0 .. 1 0 .. 1 Container Element that can contain several Defs for StateVariables.
<Objects> ID / Add Element 0 .. 1 Container Element that can contain several Defs for <Object> Element with the attributes listed in this table.
<Category> Attribute Category of the state variables nested beneath.  Should be defined at the same level where sub block is defined.

_________________

Rate this post!