Microphone control

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_t	HPI_Microphone_SetPhantomPower (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wOnOff)
	Sets the microphone phantom power on or off.
hpi_err_t	HPI_Microphone_GetPhantomPower (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *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_t HPI_Microphone_SetPhantomPower	(	const hpi_hsubsys_t *	phSubSys,
		hpi_handle_t	hControl,
		uint16_t	wOnOff
	)

Sets the microphone phantom power on or off.

Returns:

0 on success, or one of the HPI_ERROR_CODES.

Parameters:

phSubSys	Vestigial subsys handle (unused), may be set to NULL
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_t HPI_Microphone_GetPhantomPower	(	const hpi_hsubsys_t *	phSubSys,
		hpi_handle_t	hControl,
		uint16_t *	pwOnOff
	)

Gets the current microphone phantom power setting.

Returns:

0 on success, or one of the HPI_ERROR_CODES.

Parameters:

phSubSys	Vestigial subsys handle (unused), may be set to NULL
hControl	Control handle to type HPI_CONTROL_MICROPHONE
pwOnOff	Returns 1 if the microphone phantom power is on, 0 if off.