Vox control
[Mixer and Controls]

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

Functions

HPI_ERR HPI_VoxSetThreshold (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, short anGain0_01dB)
 Sets the threshold of a VOX control.
HPI_ERR HPI_VoxGetThreshold (HPI_HSUBSYS *phSubSys, HPI_HCONTROL 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 HPI_VoxSetThreshold HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  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:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to a VOX control.
anGain0_01dB  Trigger level in 100ths of a dB. For example a gain of -1400 is -14.00dB.

HPI_ERR HPI_VoxGetThreshold HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  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:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to a VOX control.
anGain0_01dB  Returned trigger level in 100ths of a dB. For example a gain of -1400 is -14.00dB.


Generated on Tue Nov 18 12:59:31 2008 for AudioScience HPI by  doxygen 1.4.6-NO