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:

hCompander	A handle to an ASX Compander control object.
pwAttack	Gets compander attack time in milliseconds.
pwDecay	Gets compander decay time in milliseconds.
pwRatio100	Gets the input to output gain ratio. Value is given in hundreths (wRatio100 = 72 means 0.72).
pnThreshold0_01dB	Gets the threshold above which the ratio applies. Value is given in hundreths.
pnMakeupGain0_01dB	Receives 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:

hCompander	A handle to an ASX Compander control object.
index	Index of timeconstant to get.
pnAttack	Gets 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:

hCompander	A handle to an ASX Compander control object.
index	Index of timeconstant to get.
pnDecay	Gets 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:

hCompander	A handle to an ASX Compander control object.
nOn	Gets 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:

hCompander	A handle to an ASX Compander control object.
fMakeupGain	Returns 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:

hCompander	A handle to an ASX Compander control object.
index	Index of rtio to get.
fRatio	Returned 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:

hCompander	A handle to an ASX Compander control object.
index	Index of threshold to get.
pnThreshold	Returned 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:

hCompander	A handle to an ASX Compander control object.
wAttack	Sets compander attack time in milliseconds.
wDecay	Sets compander decay time in milliseconds.
wRatio100	Sets the input to output gain ratio. Value is given in hundreths (wRatio100 = 72 means 0.72).
nThreshold0_01dB	Sets the threshold above which the ratio applies. Value is given in hundreths.
nMakeupGain0_01dB	Adds 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:

hCompander	A handle to an ASX Compander control object.
index	Index of timeconstant to set.
nAttack	Sets 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:

hCompander	A handle to an ASX Compander control object.
index	Index of timeconstant to set.
nDecay	Sets 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:

hCompander	A handle to an ASX Compander control object.
nOn	Sets 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:

hCompander	A handle to an ASX Compander control object.
fMakeupGain	The 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:

hCompander	A handle to an ASX Compander control object.
index	Index of rtio to set.
fRatio	Ratio 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:

hCompander	A handle to an ASX Compander control object.
index	Index of threshold to set.
nThreshold	Threshold in dbFS.

Returns:

Returns 0 if there is no error, otherwise one of asxERROR is returned.