Microphone control
[Mixer and Controls]

A Microphone control of type HPI_CONTROL_MICROPHONE is always located on a source node of type HPI_SOURCE_NODE_MICROPHONE. More...

Functions

HPI_ERR HPI_Microphone_SetPhantomPower (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wOnOff)
 Sets the microphone phantom power on or off.
HPI_ERR HPI_Microphone_GetPhantomPower (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwOnOff)
 Gets the current microphone phantom power setting.

Detailed Description

A Microphone control of type HPI_CONTROL_MICROPHONE is always located on a source node of type HPI_SOURCE_NODE_MICROPHONE.

This node type receives an audio signal from a microphone. If the microphone has adjustable gain, then a VOLUME control will also be present on the node. Currently the Microphone control is only used to turn on/off the microphone's phantom power.


Function Documentation

HPI_ERR HPI_Microphone_SetPhantomPower HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wOnOff
 

Sets the microphone phantom power on or off.

Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  subsystem handle
hControl  Control handle to type HPI_CONTROL_MICROPHONE
wOnOff  Should be set to 1 to turn on the microphone phantom power and 0 to turn it off.

HPI_ERR HPI_Microphone_GetPhantomPower HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16 *  pwOnOff
 

Gets the current microphone phantom power setting.

Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  subsystem handle
hControl  Control handle to type HPI_CONTROL_MICROPHONE
pwOnOff  Returns 1 if the microphone phantom power is on, 0 if off.


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