AudioScience HPI Version_4.24.1
Functions

Multiplexer control

Controls

This control allows one of many sources to be connected to a destination Typically used on the instream (record) side to select a record input or on the linein to select analog or digital input. More...

Functions

hpi_err_t HPI_Multiplexer_SetSource (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wSourceNodeType, uint16_t wSourceNodeIndex)
 Set the signal source that the multiplexer will send to the destination.
hpi_err_t HPI_Multiplexer_GetSource (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *wSourceNodeType, uint16_t *wSourceNodeIndex)
 Get the signal source that the multiplexer is currently connected to.
hpi_err_t HPI_Multiplexer_QuerySource (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t *wSourceNodeType, uint16_t *wSourceNodeIndex)
 Establish valid source node settings for this multiplexer.

Detailed Description

This control allows one of many sources to be connected to a destination Typically used on the instream (record) side to select a record input or on the linein to select analog or digital input.


Function Documentation

hpi_err_t HPI_Multiplexer_SetSource ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  wSourceNodeType,
uint16_t  wSourceNodeIndex 
)

Set the signal source that the multiplexer will send to the destination.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlControl handle to type HPI_CONTROL_MULTIPLEXER
wSourceNodeTypesource node type - one of HPI_SOURCENODES
wSourceNodeIndexa 0 based index
hpi_err_t HPI_Multiplexer_GetSource ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t *  wSourceNodeType,
uint16_t *  wSourceNodeIndex 
)

Get the signal source that the multiplexer is currently connected to.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlControl handle to type HPI_CONTROL_MULTIPLEXER
wSourceNodeTypesource node type - one of HPI_SOURCENODES
wSourceNodeIndexa 0 based index
hpi_err_t HPI_Multiplexer_QuerySource ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  wIndex,
uint16_t *  wSourceNodeType,
uint16_t *  wSourceNodeIndex 
)

Establish valid source node settings for this multiplexer.

Call with wIndex starting at zero, incrementing until a non-zero return value indicates that the current wIndex is invalid, so querying should be terminated.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlControl handle to type HPI_CONTROL_MULTIPLEXER
wIndexa 0 based index
wSourceNodeTypesource node type - one of HPI_SOURCENODES
wSourceNodeIndexa 0 based index