AudioScience HPI Version_4.18.
Functions

Subsystem

Functions

hpi_hsubsys_t * HPI_SubSysCreate (void)
 HPI Subsystem create.
void HPI_SubSysFree (const hpi_hsubsys_t *phSubSys)
 HPI Subsystem free.
hpi_err_t HPI_SubSysGetVersionEx (const hpi_hsubsys_t *phSubSys, uint32_t *pdwVersionEx)
 Extended HPI_SubSysGetVersion() that returns Major, Minor and Build versions Returns extended HPI subsystem version that was embedded into the HPI module at compile time.
hpi_err_t HPI_SubSysGetNumAdapters (const hpi_hsubsys_t *phSubSys, int *pnNumAdapters)
 Return the total number of adapters including networked adapters.
hpi_err_t HPI_SubSysGetAdapter (const hpi_hsubsys_t *phSubSys, int nIterator, uint32_t *pdwAdapterIndex, uint16_t *pwAdapterType)
 Extended version of HPI_SubSysFindAdapters() that iterates through all adapters present, returning adapter index and type for each one.
hpi_err_t HPI_SubSysSetHostNetworkInterface (const hpi_hsubsys_t *phSubSys, const char *szInterface)
 Sets the HPI networking subsystem to use the network interface specified.

Function Documentation

hpi_hsubsys_t* HPI_SubSysCreate ( void  )

HPI Subsystem create.

Creates, opens and initializes the audio subsystem. Must be called before other HPI functions are called.

Returns:
Non-zero pointer on success, NULL on error.
void HPI_SubSysFree ( const hpi_hsubsys_t *  phSubSys)

HPI Subsystem free.

Closes the HPI subsystem, freeing any resources allocated. Must be the last HPI function called.

Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hpi_err_t HPI_SubSysGetVersionEx ( const hpi_hsubsys_t *  phSubSys,
uint32_t *  pdwVersionEx 
)

Extended HPI_SubSysGetVersion() that returns Major, Minor and Build versions Returns extended HPI subsystem version that was embedded into the HPI module at compile time.

On a Windows machine this version is embedded in the kernel driver .sys file.

Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
pdwVersionEx32 bit word containing version of HPI.
B23..16 = Major version
B15..8 = Minor version
B7..0 = Build version
i.e. 0x00030402 is version 3.04.02
Returns:
0 on success, or one of the HPI_ERROR_CODES.
hpi_err_t HPI_SubSysGetNumAdapters ( const hpi_hsubsys_t *  phSubSys,
int *  pnNumAdapters 
)

Return the total number of adapters including networked adapters.

If multiple adapters have the same adapter index (jumper setting) they will be included in the total.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
pnNumAdapterstotal number of adapters including local and networked.
hpi_err_t HPI_SubSysGetAdapter ( const hpi_hsubsys_t *  phSubSys,
int  nIterator,
uint32_t *  pdwAdapterIndex,
uint16_t *  pwAdapterType 
)

Extended version of HPI_SubSysFindAdapters() that iterates through all adapters present, returning adapter index and type for each one.

If an adapter's index is duplicated then only one will return success; any others will set the adapter type and index (to report the error to the user) and return HPI_ERROR_DUPLICATE_ADAPTER_NUMBER.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
nIteratorAdapter iterator {0 .. total number of adapters - 1}.
pdwAdapterIndexIndex of adapter.
pwAdapterTypeType of adapter.
hpi_err_t HPI_SubSysSetHostNetworkInterface ( const hpi_hsubsys_t *  phSubSys,
const char *  szInterface 
)

Sets the HPI networking subsystem to use the network interface specified.

This is a required call before UDP messaging will work to interface with an ASI2416.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
szInterfaceString containing network interface information. On Windows this is the IP address of the network adapter, ie "192.168.1.11".

References HPI_ERROR_INVALID_RESOURCE.