Utility Functions

Functions
void	HPI_GetErrorText (HW16 wError, char *pszErrorText)
	Convert one of the HPI Error codes into a string.
HPI_ERR	HPI_FormatCreate (HPI_FORMAT *pFormat, HW16 wChannels, HW16 wFormat, HW32 dwSampleRate, HW32 dwBitRate, HW32 dwAttributes)
	Initialize an audio format structure, given various defining parameters.
HPI_ERR	HPI_DataCreate (HPI_DATA *pData, HPI_FORMAT *pFormat, HW8 *pbData, HW32 dwDataSize)
	Initialize a HPI_DATA structure.

---

Function Documentation

void HPI_GetErrorText (  HW16  wError, char *  pszErrorText )

Convert one of the HPI Error codes into a string. Parameters: wError  the error code pszErrorText  pointer to callers buffer. Must be at least 200 bytes!

HPI_ERR HPI_FormatCreate (  HPI_FORMAT *  pFormat, HW16  wChannels, HW16  wFormat, HW32  dwSampleRate, HW32  dwBitRate, HW32  dwAttributes )

Initialize an audio format structure, given various defining parameters. Returns: 0 on success, or one of the HPI Error codes. Parameters: pFormat  Pointer to the format structure to be initialized. wChannels  From 1 to 8. wFormat  One of the Audio format types dwSampleRate  Sample rate in Hz. Samplerate must be between 8000 and 200000. dwBitRate  Bits per second, must be supplied for MPEG formats, it is calculated for PCM formats. dwAttributes  Format dependent attributes. E.g. MPEG modes

HPI_ERR HPI_DataCreate (  HPI_DATA *  pData, HPI_FORMAT *  pFormat, HW8 *  pbData, HW32  dwDataSize )

Initialize a HPI_DATA structure. Deprecated: HPI_DATA struct may be removed from a future version. To avoid using HPI_DATA switch to using HPI_OutStreamWriteBuf() and HPI_InStreamReadBuf() Parameters: pData  [inout] Structure to be initialised pFormat  [in] format of the data pbData  [in] pointer to data buffer dwDataSize  [in] amount of data in buffer

---