Silence detector control functions.


Detailed Description

These functions control a silence detector.


Functions

ASX32_API ASX_ERROR ASX_SilenceDetector_SetEnable (ASX_HANDLE hSilenceDetector, const unsigned int nEnable)
 Turns the entire silence detector on and off.
ASX32_API ASX_ERROR ASX_SilenceDetector_GetEnable (ASX_HANDLE hSilenceDetector, unsigned int *nEnable)
 Returns whether the entire silence detector is on or off.
ASX32_API ASX_ERROR ASX_SilenceDetector_SetEventEnable (ASX_HANDLE hSilenceDetector, const unsigned int nEnable)
 Turns the event reporting function of the silence detector on and off.
ASX32_API ASX_ERROR ASX_SilenceDetector_GetEventEnable (ASX_HANDLE hSilenceDetector, unsigned int *nEnable)
 Returns whether the event reporting function of the silence detector is on or off.
ASX32_API ASX_ERROR ASX_SilenceDetector_SetDelay (ASX_HANDLE hSilenceDetector, const unsigned int Delay)
 Set the silence detector delay.
ASX32_API ASX_ERROR ASX_SilenceDetector_GetDelay (ASX_HANDLE hSilenceDetector, unsigned int *Delay)
 Get the silence detector delay.
ASX32_API ASX_ERROR ASX_SilenceDetector_SetThreshold (ASX_HANDLE hSilenceDetector, const float fThreshold)
 Sets the silence detector threshold (units of dB).
ASX32_API ASX_ERROR ASX_SilenceDetector_GetThreshold (ASX_HANDLE hSilenceDetector, float *fThreshold)
 Gets the silence detector threshold (units of dB).
ASX32_API ASX_ERROR ASX_SilenceDetector_GetState (ASX_HANDLE hSilenceDetector, unsigned int *nState)
 Gets the silence detector state.


Function Documentation

ASX32_API ASX_ERROR ASX_SilenceDetector_GetDelay ASX_HANDLE  hSilenceDetector,
unsigned int *  Delay
 

Get the silence detector delay.

Parameters:
hSilenceDetector A handle to an ASX silence detector control.
Delay Delay in milliseconds after signal falls below threshold before silence is indicated.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_SilenceDetector_GetEnable ASX_HANDLE  hSilenceDetector,
unsigned int *  nEnable
 

Returns whether the entire silence detector is on or off.

Parameters:
hSilenceDetector A handle to an ASX silence detector control.
nEnable A return value of 1 implies on, while 0 implies off.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_SilenceDetector_GetEventEnable ASX_HANDLE  hSilenceDetector,
unsigned int *  nEnable
 

Returns whether the event reporting function of the silence detector is on or off.

Parameters:
hSilenceDetector A handle to an ASX silence detector control.
nEnable A return value of 1 implies on, while 0 implies off.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_SilenceDetector_GetState ASX_HANDLE  hSilenceDetector,
unsigned int *  nState
 

Gets the silence detector state.

The state is a bitfield. Pairs of bits represent left and right channels of detectors.

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

ASX32_API ASX_ERROR ASX_SilenceDetector_GetThreshold ASX_HANDLE  hSilenceDetector,
float *  fThreshold
 

Gets the silence detector threshold (units of dB).

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

ASX32_API ASX_ERROR ASX_SilenceDetector_SetDelay ASX_HANDLE  hSilenceDetector,
const unsigned int  Delay
 

Set the silence detector delay.

Parameters:
hSilenceDetector A handle to an ASX silence detector control.
Delay Delay in milliseconds after signal falls below threshold before silence is indicated.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_SilenceDetector_SetEnable ASX_HANDLE  hSilenceDetector,
const unsigned int  nEnable
 

Turns the entire silence detector on and off.

Parameters:
hSilenceDetector A handle to an ASX tone detector control.
nEnable A value of 1 enables the silence detector and a value of 0 disables it.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_SilenceDetector_SetEventEnable ASX_HANDLE  hSilenceDetector,
const unsigned int  nEnable
 

Turns the event reporting function of the silence detector on and off.

Parameters:
hSilenceDetector A handle to an ASX silence detector control.
nEnable A value of 1 enables the silence detector event reporting and a value of 0 disables it.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_SilenceDetector_SetThreshold ASX_HANDLE  hSilenceDetector,
const float  fThreshold
 

Sets the silence detector threshold (units of dB).

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


Generated on Tue Nov 18 13:03:41 2008 for ASX by  doxygen 1.4.6-NO