Silence Detector Controls
[Mixer and Controls]

The silence detector control monitors its input for silence exceeding a set duration. More...

Functions

HPI_ERR HPI_SilenceDetector_GetState (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *State)
 Get the State of a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_SetEnable (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 Enable)
 Enable a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_GetEnable (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *Enable)
 Get the Enable setting of a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_SetEventEnable (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 EventEnable)
 Set the event generation by a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_GetEventEnable (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *EventEnable)
 Get the event generation enable setting of a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_SetDelay (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 Delay)
 Set the Delay of a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_GetDelay (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *Delay)
 Get the trigger delay of a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_SetThreshold (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, int Threshold)
 Set the Threshold of a SilenceDetector control.
HPI_ERR HPI_SilenceDetector_GetThreshold (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, int *Threshold)
 Get the Threshold of a SilenceDetector control.

Detailed Description

The silence detector control monitors its input for silence exceeding a set duration.

Silence is defined as signal below a specified threshold set by HPI_SilenceDetector_SetThreshold() The duration is specified by HPI_SilenceDetector_SetDelay() silence-detected state is reset immediately the signal exceeds the threshold (no delay)


Function Documentation

HPI_ERR HPI_SilenceDetector_GetState const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32 *  State
 

Get the State of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
*State The state is a bitmap corresponding to the channels being monitored (LSB=left channel, LSB+1=right channel)
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_SetEnable const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32  Enable
 

Enable a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
*Enable 1=enable, 0=disable
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_GetEnable const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32 *  Enable
 

Get the Enable setting of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
Enable 1=enable, 0=disable
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_SetEventEnable const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32  EventEnable
 

Set the event generation by a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
EventEnable 1=enable, 0=disable
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_GetEventEnable const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32 *  EventEnable
 

Get the event generation enable setting of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
*EventEnable 1=enable, 0=disable
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_SetDelay const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32  Delay
 

Set the Delay of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
Delay Trigger delay in milliseconds, max 60000 (60 seconds)
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_GetDelay const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32 *  Delay
 

Get the trigger delay of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
*Delay see HPI_SilenceDetector_SetDelay()
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_SetThreshold const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
int  Threshold
 

Set the Threshold of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
Threshold in millibels wrt full scale. E.g. -4000 -> -40dBFS threshold.
Returns:
0 on success, or one of the HPI_ERROR_CODES.

HPI_ERR HPI_SilenceDetector_GetThreshold const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
int *  Threshold
 

Get the Threshold of a SilenceDetector control.

Parameters:
phSubSys subsystem handle
hControl silence detector handle
Threshold see HPI_SilenceDetector_SetThreshold()
Returns:
0 on success, or one of the HPI_ERROR_CODES.


Generated on Thu Jul 29 09:56:42 2010 for AudioScience HPI by  doxygen 1.4.6-NO