Control generic functions

Detailed Description

These generic control functions operate on all control objects.

All ASX control objects have type and source and destination node properties. The generic control functions that follow support querying those properites.


Functions

ASX32_API ASX_ERROR ASX_Control_GetType (ASX_HANDLE hControl, enum asxCONTROL *peControl)
 Generic control function to get the type of a control.
ASX32_API ASX_ERROR ASX_Control_GetSourceNode (ASX_HANDLE hControl, ASX_HANDLE *p_hNode)
 Generic control function to get the source node of a control.
ASX32_API ASX_ERROR ASX_Control_GetDestinationNode (ASX_HANDLE hControl, ASX_HANDLE *p_hNode)
 Generic control function to get the destination node of a control.
ASX32_API ASX_ERROR ASX_Control_GetHpiControl (ASX_HANDLE hControl, void **pphHpiSubSys, unsigned int *phHpiControl)
 Tunnel through ASX to get HPI control parameters (NOT IMPLEMENTED YET).
ASX32_API ASX_ERROR ASX_Control_GetSubSystem (ASX_HANDLE hControl, ASX_HANDLE *p_hSubSystem)
 Returns the sub system handle of the given control.

Function Documentation

ASX32_API ASX_ERROR ASX_Control_GetDestinationNode (  ASX_HANDLE  hControl,
ASX_HANDLE *  p_hNode
) 
 

Generic control function to get the destination node of a control.

Parameters:
hControl A handle to an ASX control object.
p_hNode The destination node ASX object handle. This can be zero if the control does not have a destination node.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
mixer/main.c.

ASX32_API ASX_ERROR ASX_Control_GetHpiControl (  ASX_HANDLE  hControl,
void **  pphHpiSubSys,
unsigned int *  phHpiControl
) 
 

Tunnel through ASX to get HPI control parameters (NOT IMPLEMENTED YET).

Parameters:
hControl A handle to an ASX control object.
pphHpiSubSys Pointer to an HPI_HSUBSYS object.
phHpiControl Pointer to an HPI_HCONTROL object.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned. Example 
    HPI_HSUBSYS *phHPISubSys;
    HPI_HCONTROL hHPIControl;
    ASX_HANDLE hASXControl;     // this is filled in from somewhere

    ASX_Control_GetHPIControl( hASXControl, &phHPISubSys, &hHPIControl);

ASX32_API ASX_ERROR ASX_Control_GetSourceNode (  ASX_HANDLE  hControl,
ASX_HANDLE *  p_hNode
) 
 

Generic control function to get the source node of a control.

Parameters:
hControl A handle to an ASX control object.
p_hNode The source node ASX object handle. This can be zero if the control does not have a source node.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
mixer/main.c.

ASX32_API ASX_ERROR ASX_Control_GetSubSystem (  ASX_HANDLE  hControl,
ASX_HANDLE *  p_hSubSystem
) 
 

Returns the sub system handle of the given control.

Parameters:
hControl A handle to an ASX control object.
p_hSubSystem The returned ASX sub system handle.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_Control_GetType (  ASX_HANDLE  hControl,
enum asxCONTROL *  peControl
) 
 

Generic control function to get the type of a control.

Parameters:
hControl A handle to an ASX control object.
peControl The returned control type will be one of asxCONTROL.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
dual_mono_play/main.c, dual_mono_record/main.c, mixer/main.c, mux/main.c, play/main.c, tuner/main.c, and volume/main.c.

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