Channel Mode control functions.


Detailed Description

These functions support channel mode operations that can be used to swap left and right audio channels, or convert stereo sources to mono outputs etc.


Functions

ASX32_API ASX_ERROR ASX_ChannelMode_Enumerate (ASX_HANDLE hMode, const int nIndex, enum asxCHANNELMODE *peMode, int *pnCount)
 Enumerate each channel mode option.
ASX32_API ASX_ERROR ASX_ChannelMode_Get (ASX_HANDLE hMode, enum asxCHANNELMODE *peMode)
 Get the current channel mode.
ASX32_API ASX_ERROR ASX_ChannelMode_Set (ASX_HANDLE hMode, const enum asxCHANNELMODE eMode)
 Set the current channel mode.


Function Documentation

ASX32_API ASX_ERROR ASX_ChannelMode_Enumerate ASX_HANDLE  hMode,
const int  nIndex,
enum asxCHANNELMODE peMode,
int *  pnCount
 

Enumerate each channel mode option.

Parameters:
hMode A handle to an ASX channel mode control.
nIndex The index of the channel mode option to fetch.
peMode The returned channel mode option. See asxCHANNELMODE for available settings.
pnCount The total number of available mode options.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_ChannelMode_Get ASX_HANDLE  hMode,
enum asxCHANNELMODE peMode
 

Get the current channel mode.

Parameters:
hMode A handle to an ASX channel mode control.
peMode The returned channel mode. See asxCHANNELMODE for different mode options.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_ChannelMode_Set ASX_HANDLE  hMode,
const enum asxCHANNELMODE  eMode
 

Set the current channel mode.

Parameters:
hMode A handle to an ASX channel mode control.
eMode The channel mode to set. This must be one of the options returned by calls to ASX_ChannelMode_Enumerate().
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
dual_mono_play/main.c, and dual_mono_record/main.c.


Generated on Tue Nov 18 13:03:41 2008 for ASX by  doxygen 1.4.6-NO