AudioScience HPI Version_4.22.0
Enumerations | Functions

Channel Mode control

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_t HPI_ChannelMode_QueryMode (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hMode, const uint32_t dwIndex, uint16_t *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_t HPI_ChannelModeSet (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wMode)
 Set the channel mode.
hpi_err_t HPI_ChannelModeGet (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *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

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_t HPI_ChannelMode_QueryMode ( const hpi_hsubsys_t *  phSubSys,
const hpi_handle_t  hMode,
const uint32_t  dwIndex,
uint16_t *  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:
phSubSysVestigial subsys handle (unused), may be set to NULL
hModeControl to query
dwIndexIndex for possible attribute values
pwModemode

References HPI_ControlQuery().

hpi_err_t HPI_ChannelModeSet ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  wMode 
)

Set the channel mode.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle of a Channel Mode control
wModeOne of the supported HPI_CHANNEL_MODES
hpi_err_t HPI_ChannelModeGet ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t *  wMode 
)

Get the current channel mode.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle of a Channel Mode control
wModeOne of the supported HPI_CHANNEL_MODES.