ASX Version4.20.14
Functions

Compander control functions

These functions implement Compander settings. More...

Functions

ASX32_API ASX_ERROR ASX_Compander_Set (ASX_HANDLE hCompander, const unsigned short wAttack, const unsigned short wDecay, const short wRatio100, const short nThreshold0_01dB, const short nMakeupGain0_01dB)
ASX32_API ASX_ERROR ASX_Compander_Get (ASX_HANDLE hCompander, unsigned short *pwAttack, unsigned short *pwDecay, short *pwRatio100, short *pnThreshold0_01dB, short *pnMakeupGain0_01dB)
ASX32_API ASX_ERROR ASX_Compander_SetEnable (ASX_HANDLE hCompander, const unsigned int nOn)
 Sets the on/off parameter for the compander.
ASX32_API ASX_ERROR ASX_Compander_GetEnable (ASX_HANDLE hCompander, unsigned int *nOn)
 Gets the on/off parameter for the compander.
ASX32_API ASX_ERROR ASX_Compander_SetMakeupGain (ASX_HANDLE hCompander, const float fMakeupGain)
 Set the compander makeup gain.
ASX32_API ASX_ERROR ASX_Compander_GetMakeupGain (ASX_HANDLE hCompander, float *fMakeupGain)
 Get the compander makeup gain.
ASX32_API ASX_ERROR ASX_Compander_SetAttackTimeConstant (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, const unsigned int nAttack)
 Set the attack time constant in ms.
ASX32_API ASX_ERROR ASX_Compander_GetAttackTimeConstant (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, unsigned int *pnAttack)
 Get the attack time constant in ms.
ASX32_API ASX_ERROR ASX_Compander_SetDecayTimeConstant (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, const unsigned int nDecay)
 Set the decay time constant in ms.
ASX32_API ASX_ERROR ASX_Compander_GetDecayTimeConstant (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, unsigned int *pnDecay)
 Get the decay time constant in ms.
ASX32_API ASX_ERROR ASX_Compander_SetThreshold (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, const float nThreshold)
 Set the compander threshold in dbFS.
ASX32_API ASX_ERROR ASX_Compander_GetThreshold (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, float *pnThreshold)
 Get the compander threshold in dbFS.
ASX32_API ASX_ERROR ASX_Compander_SetRatio (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, const float fRatio)
 Set the compander ratio (slope).
ASX32_API ASX_ERROR ASX_Compander_GetRatio (ASX_HANDLE hCompander, enum asxCOMPANDER_INDEX index, float *fRatio)
 Get the compander ratio (slope).

Detailed Description

These functions implement Compander settings.


Function Documentation

ASX32_API ASX_ERROR ASX_Compander_Get ( ASX_HANDLE  hCompander,
unsigned short *  pwAttack,
unsigned short *  pwDecay,
short *  pwRatio100,
short *  pnThreshold0_01dB,
short *  pnMakeupGain0_01dB 
)
Deprecated:
This function has been broekn up in to individual Get() functions. Gets the parameters for the compander.
Parameters:
hCompanderA handle to an ASX Compander control object.
pwAttackGets compander attack time in milliseconds.
pwDecayGets compander decay time in milliseconds.
pwRatio100Gets the input to output gain ratio. Value is given in hundreths (wRatio100 = 72 means 0.72).
pnThreshold0_01dBGets the threshold above which the ratio applies. Value is given in hundreths.
pnMakeupGain0_01dBReceives the positive or negative offset to the output gain. Value is given in hundreths.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_GetAttackTimeConstant ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
unsigned int *  pnAttack 
)

Get the attack time constant in ms.

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of timeconstant to get.
pnAttackGets attack time in milliseconds.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_GetDecayTimeConstant ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
unsigned int *  pnDecay 
)

Get the decay time constant in ms.

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of timeconstant to get.
pnDecayGets decay time in milliseconds.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_GetEnable ( ASX_HANDLE  hCompander,
unsigned int *  nOn 
)

Gets the on/off parameter for the compander.

Parameters:
hCompanderA handle to an ASX Compander control object.
nOnGets the compander ton/off status.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_GetMakeupGain ( ASX_HANDLE  hCompander,
float *  fMakeupGain 
)

Get the compander makeup gain.

Parameters:
hCompanderA handle to an ASX Compander control object.
fMakeupGainReturns the current makeup gain in dBFS.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_GetRatio ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
float *  fRatio 
)

Get the compander ratio (slope).

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of rtio to get.
fRatioReturned ratio. 1.0 is 1:1.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_GetThreshold ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
float *  pnThreshold 
)

Get the compander threshold in dbFS.

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of threshold to get.
pnThresholdReturned threshold in dbFS.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_Set ( ASX_HANDLE  hCompander,
const unsigned short  wAttack,
const unsigned short  wDecay,
const short  wRatio100,
const short  nThreshold0_01dB,
const short  nMakeupGain0_01dB 
)
Deprecated:
This function has been broekn up in to individual Set() functions. Sets the parameters for the compander.
Parameters:
hCompanderA handle to an ASX Compander control object.
wAttackSets compander attack time in milliseconds.
wDecaySets compander decay time in milliseconds.
wRatio100Sets the input to output gain ratio. Value is given in hundreths (wRatio100 = 72 means 0.72).
nThreshold0_01dBSets the threshold above which the ratio applies. Value is given in hundreths.
nMakeupGain0_01dBAdds a positive or negative offset to the output gain. Value is given in hundreths.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_SetAttackTimeConstant ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
const unsigned int  nAttack 
)

Set the attack time constant in ms.

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of timeconstant to set.
nAttackSets attack time in milliseconds.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_SetDecayTimeConstant ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
const unsigned int  nDecay 
)

Set the decay time constant in ms.

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of timeconstant to set.
nDecaySets decay time in milliseconds.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_SetEnable ( ASX_HANDLE  hCompander,
const unsigned int  nOn 
)

Sets the on/off parameter for the compander.

Parameters:
hCompanderA handle to an ASX Compander control object.
nOnSets compander to on if set to 1.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_SetMakeupGain ( ASX_HANDLE  hCompander,
const float  fMakeupGain 
)

Set the compander makeup gain.

Parameters:
hCompanderA handle to an ASX Compander control object.
fMakeupGainThe makeup gain to set in dBFS.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_SetRatio ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
const float  fRatio 
)

Set the compander ratio (slope).

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of rtio to set.
fRatioRatio to set. 1.0 is 1:1.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Compander_SetThreshold ( ASX_HANDLE  hCompander,
enum asxCOMPANDER_INDEX  index,
const float  nThreshold 
)

Set the compander threshold in dbFS.

Parameters:
hCompanderA handle to an ASX Compander control object.
indexIndex of threshold to set.
nThresholdThreshold in dbFS.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.