Device description file: Common section for all StateVariables

February 19, 2020
2 mins read

Name	Type	Def	Tmp	Incl	Description
Key	Attr		1		Unique key to identify the object Tmp.
Template	Attr			1	Key to object Tmp.
Name	Attr	1		1	Name of the StateVariale.
ID	Attr	1		1	HiQnet ID of the StateVariable must be unique in an object. Recommendation: Start with zero and increase this number by one for every StateVariable of the object.
<DataType>	Elmt	1	1		Data type of the StateVariable. Possible values: Byte UByte Word UWord Long ULong Float Dfloat Block String Long64 ULong64 BigBlock Custom Undefined
<DefaultValue>	Elmt	1	1	0 .. 1	The default value of the StateVariable. The Tmp value can be overwritten in Incl.
<BuddyGroup>	Elmt	0 .. 1	0 .. 1		Functionality group. Possible Values: Compressor Limiter Gate PEQ Bandpass AGC AFS DeEsser Notch GEQ FIR None
<BuddyType>	Elmt	0 .. 1	0 .. 1		Functionality type in the functionality group. Possible values: ChannelActive Active Frequency Q Slope FilterType HighPassFreq HighPassFreqActive LowPassFreq LowPassFreqActive HighPassEnable LowPassEnable HighPassSlope LowPassSlope Threshold Ratio Gain Knee Target Window Range LowThreshold LimiterThreshold LimiterAttack LimiterRelease PeakStopPlus Overshoot AutoMode Attack Hold Release Phase Polarity Amount IdleGain ReturnTo GainReductionMeter SignalMeter ThresholdMeter BandpassGain Latency48 FIRHighpassFreq FIRLowpassFreq FIRHighpassType FIRLowpassType FIRHighpassFilterFamily FIRLowpassFilterFamily SampleRate Coefficients, DownsampledCoefficients LowpassCoefficients Delay
<Buddies>	Elmt	0 .. 1		0 .. 1	A collection of ID separated by ‘,’ of all StateVariables that belong to the same functionality.
<TargetValue>	Elmt	0 .. 1	0 .. 1	0 .. 1	Def of the data format on the target device.
<Streamable> Is obsolete with J +1 release, use <StreamIndex> instead	Elmt	0 .. 1	0 .. 1		Value should be “True” or “False”. Specifies whether the state variable is streamable or not. Default value: “False”
<StreamIndex> added with J + 1 release.	Elmt	0 .. 1	0 .. 1		Should be set, if the SV is streamable. Is a byte that specifies the index of the specific stream within an audio object.