Channel Mode control
[Mixer and Controls]

A Channel Mode allows you to swap the left and right channels, mix the left and right channels into the left or right channel only, or send the left or right channels to both left and right. More...

Enumerations

enum  HPI_CHANNEL_MODES {
  HPI_CHANNEL_MODE_NORMAL = 1, HPI_CHANNEL_MODE_SWAP = 2, HPI_CHANNEL_MODE_LEFT_TO_STEREO = 3, HPI_CHANNEL_MODE_RIGHT_TO_STEREO = 4,
  HPI_CHANNEL_MODE_STEREO_TO_LEFT = 5, HPI_CHANNEL_MODE_STEREO_TO_RIGHT = 6
}
 Channel Modes Used for HPI_ChannelModeSet/Get(). More...

Functions

HPI_ERR HPI_ChannelMode_QueryMode (const HPI_HSUBSYS *phSubSys, const HPI_HCONTROL hMode, const HW32 dwIndex, HW16 *pwMode)
 Query the available channel modes for this control Iterate dwIndex until an error is returned to get allowed values for channel mode in *pwMode.
HPI_ERR HPI_ChannelModeSet (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wMode)
 Set the channel mode.
HPI_ERR HPI_ChannelModeGet (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *wMode)
 Get the current channel mode.

Detailed Description

A Channel Mode allows you to swap the left and right channels, mix the left and right channels into the left or right channel only, or send the left or right channels to both left and right.


Enumeration Type Documentation

enum HPI_CHANNEL_MODES
 

Channel Modes Used for HPI_ChannelModeSet/Get().

Enumerator:
HPI_CHANNEL_MODE_NORMAL  Left channel out = left channel in, Right channel out = right channel in.
HPI_CHANNEL_MODE_SWAP  Left channel out = right channel in, Right channel out = left channel in.
HPI_CHANNEL_MODE_LEFT_TO_STEREO  Left channel out = left channel in, Right channel out = left channel in.
HPI_CHANNEL_MODE_RIGHT_TO_STEREO  Left channel out = right channel in, Right channel out = right channel in.
HPI_CHANNEL_MODE_STEREO_TO_LEFT  Left channel out = (left channel in + right channel in)/2, Right channel out = mute.
HPI_CHANNEL_MODE_STEREO_TO_RIGHT  Left channel out = mute, Right channel out = (right channel in + left channel in)/2.


Function Documentation

HPI_ERR HPI_ChannelMode_QueryMode const HPI_HSUBSYS *  phSubSys,
const HPI_HCONTROL  hMode,
const HW32  dwIndex,
HW16 *  pwMode
 

Query the available channel modes for this control Iterate dwIndex until an error is returned to get allowed values for channel mode in *pwMode.

Parameters:
phSubSys  Pointer to HPI subsystem handle
hMode  Control to query
dwIndex  Index for possible attribute values
pwMode  mode

HPI_ERR HPI_ChannelModeSet const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wMode
 

Set the channel mode.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSys  Subsystem handle
hControl  Handle of a Channel Mode control
wMode  One of the supported HPI_CHANNEL_MODES

HPI_ERR HPI_ChannelModeGet const HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16 *  wMode
 

Get the current channel mode.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSys  Subsystem handle
hControl  Handle of a Channel Mode control
wMode  One of the supported HPI_CHANNEL_MODES.


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