AudioScience HPI Version_4.20.8
Functions

Vox control

Controls

VOX controls are always situated on a destination node of type HPI_DESTNODE_ISTREAM. More...

Functions

hpi_err_t HPI_VoxSetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anGain0_01dB)
 Sets the threshold of a VOX control.
hpi_err_t HPI_VoxGetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *anGain0_01dB)
 Gets the current threshold of a VOX control.

Detailed Description

VOX controls are always situated on a destination node of type HPI_DESTNODE_ISTREAM.

The VOX control specifies the signal level required for recording to begin. Until the signal exceeds the VOX level no samples are recorded to the record stream. After the VOX level has been exceeded, recording continues until the stream is stopped or reset.

A trigger level of -100 dB indicates that recording begins with any level audio signal. A single threshold level is used for both left and right channels. If either channel exceeds the threshold, recording will proceed.


Function Documentation

hpi_err_t HPI_VoxSetThreshold ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
short  anGain0_01dB 
)

Sets the threshold of a VOX control.

Note the threshold is in units of 0.01dB. The threshold will typically range between 0 and -100dB. On startup the VOX control is set to -100 dB.

Returns:
0 on success, or one of the HPI_ERROR_CODES.

Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to a VOX control.
anGain0_01dBTrigger level in 100ths of a dB. For example a gain of -1400 is -14.00dB.
hpi_err_t HPI_VoxGetThreshold ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
short *  anGain0_01dB 
)

Gets the current threshold of a VOX control.

Note the threshold is in units of 0.01dB. The threshold will typically range between 0 and -100dB. On startup the VOX control is set to -100 dB.

Returns:
0 on success, or one of the HPI_ERROR_CODES.

Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to a VOX control.
anGain0_01dBReturned trigger level in 100ths of a dB. For example a gain of -1400 is -14.00dB.