|
AudioScience HPI Version_4.24.1
|
Hardware Programming Interface (HPI) functions. More...
#include "hpi_internal.h"#include "hpicheck.h"#include "hpimsginit.h"#include <stdio.h>#include <stdlib.h>#include <memory.h>#include <math.h>#include <assert.h>#include "hpidebug.h"#include <hpirds.h>Data Structures | |
| struct | hpi_handle |
| handle struct for internal hpifunc use. More... | |
| union | handle_word |
| allow conversion from handle to uint32_t More... | |
Functions | |
| hpi_handle_t | HPI_IndexesToHandle (const char cObject, const uint16_t wAdapterIndex, const uint16_t wObjectIndex) |
| Encode 3 indices and an object type into a 32 bit handle. | |
| void | HPI_HandleToIndexes (const hpi_handle_t dwHandle, uint16_t *pwAdapterIndex, uint16_t *pwObjectIndex) |
| enum e_entity_role | HPI_Entity_GetRole (struct hpi_entity *entity) |
| Return the role of the entity. | |
| const char * | HPI_Entity_GetTypeName (struct hpi_entity *entity) |
| Return the typename of the entity. | |
| const char * | HPI_Entity_GetRoleName (struct hpi_entity *entity) |
| hpi_err_t | HPI_Entity_FindNext (struct hpi_entity *container_entity, enum e_entity_type type, enum e_entity_role role, int recursive_flag, struct hpi_entity **current_match) |
| Search for an entity with the given _type_ and _role_ in a container entity. | |
| void | HPI_Entity_Free (struct hpi_entity *entity) |
| Free an hpi_entity allocated by HPI_Universal_* and HPI_Entity_* functions. | |
| hpi_err_t | HPI_Entity_AllocAndPack (const enum e_entity_type type, const size_t item_count, const enum e_entity_role role, const void *value, const size_t value_size, struct hpi_entity **pentity) |
| Allocate and initialize an entity with the provided parameters. | |
| hpi_err_t | HPI_Entity_CopyValueFrom (struct hpi_entity *entity, enum e_entity_type type, size_t item_count, void *value_dst_p, size_t value_size) |
| Copies item_count items from the Entity's value array into *value_dst_p. | |
| hpi_err_t | HPI_Entity_Unpack (struct hpi_entity *entity, enum e_entity_type *type, size_t *item_count, enum e_entity_role *role, void **value) |
| Extracts information from an entity into the specified locations. | |
| hpi_err_t | HPI_Object_UriToHandle (const char *uri, hpi_handle_t *h) |
| Get an object handle given the object's URI. | |
| hpi_err_t | HPI_Object_GetInfoEntity (hpi_handle_t h, struct hpi_entity **info) |
| Get the complete information entity for an object addressed by handle. | |
| hpi_err_t | HPI_Object_GetInfo (hpi_handle_t hObject, enum e_entity_type type, enum e_entity_role role, void *value, size_t *value_size, size_t *value_count) |
| Get information about an object. | |
| hpi_err_t | HPI_Object_GetRole (hpi_handle_t hObject, enum e_entity_role *r) |
| Get the object role. | |
| hpi_err_t | HPI_Object_BlockParameters (hpi_handle_t hMixer, hpi_handle_t block, hpi_handle_t *params, size_t *param_count) |
| Given a block handle, return a list of parameter object handles. | |
| hpi_err_t | HPI_Object_BlockHandle (hpi_handle_t hMixer, uint16_t wSrcNodeType, uint16_t wSrcNodeTypeIndex, uint16_t wDstNodeType, uint16_t wDstNodeTypeIndex, const char *block_name, hpi_handle_t *phBlock) |
| Given block location information and name, fetch an object handle for the block. | |
| hpi_err_t | HPI_Object_ParameterHandle (hpi_handle_t hMixer, hpi_handle_t hBlock, const char *parameter_name, hpi_handle_t *phParameter) |
| Given a block handle and parameter name, fetch an object handle for the specified parameter. | |
| hpi_err_t | HPI_Object_GetValueEntity (hpi_handle_t h, struct hpi_entity **value) |
| Get the value entity of an object addressed by its handle. | |
| hpi_err_t | HPI_Object_SetValueEntity (hpi_handle_t h, const struct hpi_entity *value) |
| Set the value entity of an object addressed by its handle. | |
| hpi_err_t | HPI_Object_GetValue (hpi_handle_t h, enum e_entity_type type, size_t count, void *value, size_t value_size) |
| Retrieve an object's value. | |
| hpi_err_t | HPI_Object_SetValue (hpi_handle_t h, enum e_entity_type type, size_t count, const void *value, size_t value_size) |
| Set an object's value. | |
| void | HPI_MemFree (void *mem) |
| Free memory allocated by a previous HPI call. | |
| 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. | |
| hpi_err_t | HPI_AdapterOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex) |
| Opens an adapter for use. | |
| hpi_err_t | HPI_AdapterClose (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex) |
| Closes the adapter associated with the wAdapterIndex. | |
| hpi_err_t | HPI_AdapterSetMode (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint32_t dwAdapterMode) |
| Sets the operating mode of an adapter. | |
| hpi_err_t | HPI_AdapterSetModeEx (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint32_t dwAdapterMode, uint16_t wQueryOrSet) |
| Adapter set mode extended. | |
| hpi_err_t | HPI_AdapterGetMode (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint32_t *pdwAdapterMode) |
| Read the current adapter mode setting. | |
| hpi_err_t | HPI_AdapterGetInfo (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t *pwNumOutStreams, uint16_t *pwNumInStreams, uint16_t *pwVersion, uint32_t *pdwSerialNumber, uint16_t *pwAdapterType) |
| Obtains information about the specified adapter, including the number of output streams and number of input streams, version, serial number and it's type. | |
| hpi_err_t | HPI_AdapterGetModuleByIndex (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wModuleIndex, uint16_t *pwNumOutputs, uint16_t *pwNumInputs, uint16_t *pwVersion, uint32_t *pdwSerialNumber, uint16_t *pwModuleType, hpi_handle_t *phModule) |
| Obtains information about the specified module on an adapter, including the number of outputs and number of inputs, version, serial number and type. | |
| hpi_err_t | HPI_AdapterGetAssert2 (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t *pAssertCount, char *pszAssert, uint32_t *pParam1, uint32_t *pParam2, uint32_t *pDspStringAddr, uint16_t *pProcessorId) |
| hpi_err_t | HPI_AdapterTestAssert (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wAssertId) |
| This function tests that asserts are working correctly on the selected adapter. | |
| hpi_err_t | HPI_AdapterSetProperty (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wProperty, uint16_t wParameter1, uint16_t wParameter2) |
| Set an adapter property to a value. | |
| hpi_err_t | HPI_AdapterGetProperty (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wProperty, uint16_t *pwParameter1, uint16_t *pwParameter2) |
| Gets the value of an adapter property. | |
| hpi_err_t | HPI_FormatCreate (struct hpi_format *pFormat, uint16_t wChannels, uint16_t wFormat, uint32_t dwSampleRate, uint32_t dwBitRate, uint32_t dwAttributes) |
| Initialize an audio format structure, given various defining parameters. | |
| hpi_err_t | HPI_StreamEstimateBufferSize (struct hpi_format *pFormat, uint32_t dwHostPollingRateInMilliSeconds, uint32_t *dwRecommendedBufferSize) |
| Given a format and rate that the buffer is processed, return the correct buffer size to support ping-pong buffering of audio. | |
| hpi_err_t | HPI_OutStreamOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wOutStreamIndex, hpi_handle_t *phOutStream) |
| Open and initializes an output stream. | |
| hpi_err_t | HPI_OutStreamClose (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Closes an output stream and deallocates host buffers if they are being used. | |
| hpi_err_t | HPI_OutStreamGetInfoEx (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint16_t *pwState, uint32_t *pdwBufferSize, uint32_t *pdwDataToPlay, uint32_t *pdwSamplesPlayed, uint32_t *pdwAuxiliaryDataToPlay) |
| Get information about attributes and state of output stream. | |
| hpi_err_t | HPI_OutStreamWriteBuf (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, const uint8_t *pbData, uint32_t dwBytesToWrite, const struct hpi_format *pFormat) |
| Writes a block of audio data to the specified output stream. | |
| hpi_err_t | HPI_OutStreamStart (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Starts an output stream playing audio data. | |
| hpi_err_t | HPI_OutStreamWaitStart (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Sets an output stream to WAIT state, ready for inter-card syncing. | |
| hpi_err_t | HPI_OutStreamStop (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Stops an output stream playing audio data. | |
| hpi_err_t | HPI_OutStreamReset (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Clears the audio data buffer of an output stream. | |
| hpi_err_t | HPI_OutStreamQueryFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, struct hpi_format *pFormat) |
| Queries an OutStream to see whether it supports a certain audio format, described in pFormat. | |
| hpi_err_t | HPI_OutStreamSetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, struct hpi_format *pFormat) |
| Sets an OutStream to a certain audio format, described in pFormat. | |
| hpi_err_t | HPI_OutStreamSetVelocity (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, short nVelocity) |
| Sets the playback velocity for scrubbing. | |
| hpi_err_t | HPI_OutStreamAncillaryReset (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint16_t wMode) |
| Resets MPEG ancillary data extraction. | |
| hpi_err_t | HPI_OutStreamAncillaryGetInfo (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint32_t *pdwFramesAvailable) |
| Returns information about the Ancillary stream. | |
| hpi_err_t | HPI_OutStreamAncillaryRead (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, struct hpi_anc_frame *pAncFrameBuffer, uint32_t dwAncFrameBufferSizeInBytes, uint32_t dwNumberOfAncillaryFramesToRead) |
| Reads frames of ancillary data from a stream's ancillary data buffer to pdwBuffer. | |
| hpi_err_t | HPI_OutStreamSetTimeScale (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint32_t dwTimeScale) |
| Sets the playback timescale with pitch and content preservation. | |
| hpi_err_t | HPI_OutStreamHostBufferAllocate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint32_t dwSizeInBytes) |
| Allocates a buffer inside the driver for bus mastering transfers. | |
| hpi_err_t | HPI_OutStreamHostBufferFree (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Free any buffers allocated by HPI_OutStreamHostBufferAllocate(). | |
| hpi_err_t | HPI_OutStreamGroupAdd (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, hpi_handle_t hStream) |
| This function adds a stream to a group of streams. | |
| hpi_err_t | HPI_OutStreamGroupGetMap (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint32_t *pdwOutStreamMap, uint32_t *pdwInStreamMap) |
| This function returns information about the streams that form a group. | |
| hpi_err_t | HPI_OutStreamGroupReset (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream) |
| Resets stream grouping information for a given out stream. | |
| hpi_err_t | HPI_OutStreamWait (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint32_t dwThresholdBytes) |
| Returns when the output stream hits the threshold. | |
| hpi_err_t | HPI_OutStreamGetTimestamp (const hpi_hsubsys_t *phSubSys, hpi_handle_t hOutStream, uint32_t *pdwSample, uint32_t *pdwNanosPerSample, int64_t *pqwTimestamp) |
| Returns the timestamp from the last stream update. | |
| hpi_err_t | HPI_InStreamOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wInStreamIndex, hpi_handle_t *phInStream) |
| Open and initializes an input stream. | |
| hpi_err_t | HPI_InStreamClose (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Closes an input stream. | |
| hpi_err_t | HPI_InStreamQueryFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, const struct hpi_format *pFormat) |
| Queries an input stream to see whether it supports a certain audio format, described in pFormat. | |
| hpi_err_t | HPI_InStreamSetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, const struct hpi_format *pFormat) |
| Sets the recording format for an input stream. | |
| hpi_err_t | HPI_InStreamReadBuf (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint8_t *pbData, uint32_t dwBytesToRead) |
| Read data from an InStream into a buffer Reads dwBytesToRead bytes of audio data from the specified InStream into a memory buffer pointed to by pbData. | |
| hpi_err_t | HPI_InStreamStart (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Starts an input stream recording audio data. | |
| hpi_err_t | HPI_InStreamWaitStart (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Get a stream ready for sync'd start across multiple adapters. | |
| hpi_err_t | HPI_InStreamStop (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Stops an input stream recording audio data. | |
| hpi_err_t | HPI_InStreamReset (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Clears the audio data buffer of an input stream. | |
| hpi_err_t | HPI_InStreamGetInfoEx (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint16_t *pwState, uint32_t *pdwBufferSize, uint32_t *pdwDataRecorded, uint32_t *pdwSamplesRecorded, uint32_t *pdwAuxiliaryDataRecorded) |
| Returns extended information about the input stream. | |
| hpi_err_t | HPI_InStreamAncillaryReset (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint16_t wBytesPerFrame, uint16_t wMode, uint16_t wAlignment, uint16_t wIdleBit) |
| Initializes the MPEG Layer II / III Ancillary data channel. | |
| hpi_err_t | HPI_InStreamAncillaryGetInfo (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint32_t *pdwFrameSpace) |
| Returns information about the ancillary data stream. | |
| hpi_err_t | HPI_InStreamAncillaryWrite (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, const struct hpi_anc_frame *pAncFrameBuffer, uint32_t dwAncFrameBufferSizeInBytes, uint32_t dwNumberOfAncillaryFramesToWrite) |
| Writes frames to the stream's ancillary data buffer. | |
| hpi_err_t | HPI_InStreamHostBufferAllocate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint32_t dwSizeInBytes) |
| Allocates a buffer on the host PC for bus mastering transfers. | |
| hpi_err_t | HPI_InStreamHostBufferFree (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Free any buffers allocated by HPI_InStreamHostBufferAllocate. | |
| hpi_err_t | HPI_InStreamGroupAdd (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, hpi_handle_t hStream) |
| This function adds a stream to a group of streams. | |
| hpi_err_t | HPI_InStreamGroupGetMap (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint32_t *pdwOutStreamMap, uint32_t *pdwInStreamMap) |
| This function returns information about the streams that form a group. | |
| hpi_err_t | HPI_InStreamGroupReset (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream) |
| Resets stream grouping information for a given InStream. | |
| hpi_err_t | HPI_InStreamWait (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint32_t dwThresholdBytes) |
| Returns when the input stream hits the threshold. | |
| hpi_err_t | HPI_InStreamGetTimestamp (const hpi_hsubsys_t *phSubSys, hpi_handle_t hInStream, uint32_t *pdwSample, uint32_t *pdwNanosPerSample, int64_t *pqwTimestamp) |
| Returns the timestamp from the last stream update. | |
| hpi_err_t | HPI_MixerOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, hpi_handle_t *phMixer) |
| Opens and initializes an adapters mixer. | |
| hpi_err_t | HPI_MixerClose (const hpi_hsubsys_t *phSubSys, hpi_handle_t hMixer) |
| Closes a mixer. | |
| hpi_err_t | HPI_MixerGetControl (const hpi_hsubsys_t *phSubSys, hpi_handle_t hMixer, uint16_t wSrcNodeType, uint16_t wSrcNodeTypeIndex, uint16_t wDstNodeType, uint16_t wDstNodeTypeIndex, uint16_t wControlType, hpi_handle_t *phControl) |
| Gets a mixer control. | |
| hpi_err_t | HPI_MixerGetControlByIndex (const hpi_hsubsys_t *phSubSys, hpi_handle_t hMixer, uint16_t wControlIndex, uint16_t *pwSrcNodeType, uint16_t *pwSrcNodeIndex, uint16_t *pwDstNodeType, uint16_t *pwDstNodeIndex, uint16_t *pwControlType, hpi_handle_t *phControl) |
| Get the location and type of a mixer control by index. | |
| hpi_err_t | HPI_MixerStore (const hpi_hsubsys_t *phSubSys, hpi_handle_t hMixer, enum HPI_MIXER_STORE_COMMAND command, uint16_t wIndex) |
| Execute a command to store Mixer Controls. | |
| hpi_err_t | HPI_MixerStoreStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hMixer, uint16_t *pwControlsToStore) |
| Fetch the number of controls waiting to be stored. | |
| hpi_err_t | HPI_ControlQuery (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hControl, const uint16_t wAttrib, const uint32_t dwIndex, const uint32_t dwParam, uint32_t *pdwSetting) |
| hpi_err_t | HPI_AESEBU_Receiver_QueryFormat (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hAesRx, const uint32_t dwIndex, uint16_t *pwFormat) |
| query formats supported by this aesebu receiver Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat | |
| hpi_err_t | HPI_AESEBU_Receiver_SetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wFormat) |
| Sets the physical format of the digital audio input to either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input. | |
| hpi_err_t | HPI_AESEBU_Receiver_GetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwFormat) |
| Gets the physical format of the digital audio input : either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input. | |
| hpi_err_t | HPI_AESEBU_Receiver_GetSampleRate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwSampleRate) |
| Returns the sample rate of the incoming AES/EBU digital audio stream in *pdwSampleRate. | |
| hpi_err_t | HPI_AESEBU_Receiver_GetUserData (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t *pwData) |
| Get one of 4 userdata bytes from the AES/EBU stream. | |
| hpi_err_t | HPI_AESEBU_Receiver_GetChannelStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t *pwData) |
| Get one of 24 channel status bytes from the AES/EBU stream. | |
| hpi_err_t | HPI_AESEBU_Receiver_GetErrorStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwErrorData) |
| Get error status from the AES/EBU stream. | |
| hpi_err_t | HPI_AESEBU_Transmitter_SetSampleRate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwSampleRate) |
| Set the AES/EBU transmitters sample rate. | |
| hpi_err_t | HPI_AESEBU_Transmitter_SetUserData (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t wData) |
| Set one of 4 userdata bytes in the AES/EBU stream. | |
| hpi_err_t | HPI_AESEBU_Transmitter_SetChannelStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t wData) |
| Set one of 24 channel status bytes in the AES/EBU stream. | |
| hpi_err_t | HPI_AESEBU_Transmitter_GetChannelStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t *pwData) |
| Get a byte of channel status in the AES/EBU stream. | |
| hpi_err_t | HPI_AESEBU_Transmitter_QueryFormat (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hAesTx, const uint32_t dwIndex, uint16_t *pwFormat) |
| Query the formats supported by this AESEBU transmitter Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat. | |
| hpi_err_t | HPI_AESEBU_Transmitter_SetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wOutputFormat) |
| Set the output electrical format for the AESEBU transmitter. | |
| hpi_err_t | HPI_AESEBU_Transmitter_GetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwOutputFormat) |
| Get the current output electrical format for the AESEBU transmitter. | |
| hpi_err_t | HPI_Bitstream_GetActivity (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwClkActivity, uint16_t *pwDataActivity) |
| Returns 2 indicative measurements of the incoming data stream. | |
| hpi_err_t | HPI_ChannelMode_QueryMode (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hMode, const uint32_t dwIndex, uint16_t *pwMode) |
| Query the available channel modes for this control Iterate dwIndex until an error is returned to get allowed values for channel mode in *pwMode. | |
| hpi_err_t | HPI_ChannelModeSet (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wMode) |
| Set the channel mode. | |
| hpi_err_t | HPI_ChannelModeGet (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *wMode) |
| Get the current channel mode. | |
| hpi_err_t | HPI_Cobranet_HmiWrite (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwHmiAddress, uint32_t dwByteCount, uint8_t *pbData) |
| Write to an HMI variable. | |
| hpi_err_t | HPI_Cobranet_HmiRead (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwHmiAddress, uint32_t dwMaxByteCount, uint32_t *pdwByteCount, uint8_t *pbData) |
| Read from an HMI variable. | |
| hpi_err_t | HPI_Cobranet_HmiGetStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwStatus, uint32_t *pdwReadableSize, uint32_t *pdwWriteableSize) |
| Get the status of the last cobranet operation. | |
| hpi_err_t | HPI_Cobranet_GetIPaddress (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwIPaddress) |
| Get the CobraNet node's current IP address. | |
| hpi_err_t | HPI_Cobranet_SetIPaddress (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwIPaddress) |
| Set the CobraNet node's current IP address. | |
| hpi_err_t | HPI_Cobranet_GetStaticIPaddress (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwIPaddress) |
| Get the CobraNet node's static IP address. | |
| hpi_err_t | HPI_Cobranet_SetStaticIPaddress (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwIPaddress) |
| Set the CobraNet node's static IP address. | |
| hpi_err_t | HPI_Cobranet_GetMACaddress (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwMAC_MSBs, uint32_t *pdwMAC_LSBs) |
| Get the CobraNet node's MAC address. | |
| hpi_err_t | HPI_Compander_SetEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t enable) |
| Enable or disable the compander. | |
| hpi_err_t | HPI_Compander_GetEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *enable) |
| Get the enable state of the compander. | |
| hpi_err_t | HPI_Compander_SetMakeupGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short nMakeupGain0_01dB) |
| Set the makeup gain of a compander control. | |
| hpi_err_t | HPI_Compander_GetMakeupGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *nMakeupGain0_01dB) |
| Get the makeup gain of a compander control. | |
| hpi_err_t | HPI_Compander_SetAttackTimeConstant (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, unsigned int index, uint32_t wAttack) |
| Set the attack timeconstants. | |
| hpi_err_t | HPI_Compander_GetAttackTimeConstant (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, unsigned int index, uint32_t *attack) |
| Get the compander attack timeconstant. | |
| hpi_err_t | HPI_Compander_SetDecayTimeConstant (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, unsigned int index, uint32_t decay) |
| Set the decay timeconstants. | |
| hpi_err_t | HPI_Compander_GetDecayTimeConstant (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, unsigned int index, uint32_t *decay) |
| Get the compander attack timeconstant. | |
| hpi_err_t | HPI_Compander_SetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, unsigned int index, short nThreshold0_01dB) |
| Set the threshold for one of the compander knee points. | |
| hpi_err_t | HPI_Compander_GetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, unsigned int index, short *nThreshold0_01dB) |
| Get the threshold for one of the compander knee points. | |
| hpi_err_t | HPI_Compander_SetRatio (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t index, uint32_t wRatio100) |
| Set the ratio for one of the compander knee points. | |
| hpi_err_t | HPI_Compander_GetRatio (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t index, uint32_t *wRatio100) |
| Set the ratio for one of the compander knee points. | |
| hpi_err_t | HPI_LevelQueryRange (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *nMinGain_01dB, short *nMaxGain_01dB, short *nStepGain_01dB) |
| Query the allowed values of a level control. | |
| hpi_err_t | HPI_LevelSetGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anGain0_01dB[HPI_MAX_CHANNELS]) |
| Sets the value of a level control. | |
| hpi_err_t | HPI_LevelGetGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anGain0_01dB[HPI_MAX_CHANNELS]) |
| Gets the value of a level control. | |
| hpi_err_t | HPI_Meter_QueryChannels (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hMeter, uint32_t *pChannels) |
| Get the number of channels supported by this meter. | |
| hpi_err_t | HPI_MeterGetPeak (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anPeakdB[HPI_MAX_CHANNELS]) |
| Get the meter peak reading. | |
| hpi_err_t | HPI_MeterGetRms (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anRmsdB[HPI_MAX_CHANNELS]) |
| Get the meter RMS reading in 100ths of a dB. | |
| hpi_err_t | HPI_MeterSetRmsBallistics (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t nAttack, uint16_t nDecay) |
| Set the ballistics of the RMS part of a meter. | |
| hpi_err_t | HPI_MeterGetRmsBallistics (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pnAttack, uint16_t *pnDecay) |
| Get the ballistics settings of the RMS part of a meter. | |
| hpi_err_t | HPI_MeterSetPeakBallistics (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t nAttack, uint16_t nDecay) |
| Set the ballistics of the Peak part of a meter. | |
| hpi_err_t | HPI_MeterGetPeakBallistics (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pnAttack, uint16_t *pnDecay) |
| Get the ballistics settings of the Peak part of a meter. | |
| hpi_err_t | HPI_Microphone_SetPhantomPower (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wOnOff) |
| Sets the microphone phantom power on or off. | |
| hpi_err_t | HPI_Microphone_GetPhantomPower (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwOnOff) |
| Gets the current microphone phantom power setting. | |
| 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. | |
| hpi_err_t | HPI_ParametricEQ_GetInfo (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwNumberOfBands, uint16_t *pwOnOff) |
| Find out the number of available bands of a parametric equalizer, and whether it is enabled or not. | |
| hpi_err_t | HPI_ParametricEQ_SetState (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wOnOff) |
| Turn a parametric equalizer on or off. | |
| hpi_err_t | HPI_ParametricEQ_GetBand (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t *pnType, uint32_t *pdwFrequencyHz, short *pnQ100, short *pnGain0_01dB) |
| Get the settings of one of the filters in a parametric equalizer. | |
| hpi_err_t | HPI_ParametricEQ_SetBand (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t nType, uint32_t dwFrequencyHz, short nQ100, short nGain0_01dB) |
| Set up one of the filters in a parametric equalizer. | |
| hpi_err_t | HPI_ParametricEQ_GetCoeffs (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, short coeffs[5]) |
| Retrieve the calculated IIR filter coefficients (scaled by 1000 into integers). | |
| hpi_err_t | HPI_SampleClock_QuerySource (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hClock, const uint32_t dwIndex, uint16_t *pwSource) |
| Query valid SampleClock sources Iterate dwIndex until an error is returned to get allowed values for SampleClock source in *pwFormat. | |
| hpi_err_t | HPI_SampleClock_SetSource (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wSource) |
| Sets the clock source for the sample clock. | |
| hpi_err_t | HPI_SampleClock_GetSource (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwSource) |
| Gets the current sample clock source. | |
| hpi_err_t | HPI_SampleClock_QuerySourceIndex (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hClock, const uint32_t dwIndex, const uint32_t dwSource, uint16_t *pwSourceIndex) |
| Query the available source indices. | |
| hpi_err_t | HPI_SampleClock_SetSourceIndex (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wSourceIndex) |
| Sets the index for the currently selected source. | |
| hpi_err_t | HPI_SampleClock_GetSourceIndex (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwSourceIndex) |
| Gets the AES/EBU input used to source the adapter clock. | |
| hpi_err_t | HPI_SampleClock_QueryLocalRate (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hClock, const uint32_t dwIndex, uint32_t *pdwRate) |
| Query samplerates supported by the local PLL of this sampleclock Iterate dwIndex until an error is returned to get the list of valid PLL samplerates. | |
| hpi_err_t | HPI_SampleClock_SetLocalRate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwSampleRate) |
| Set the samplerate of the sample clock's local PLL This samplerate becomes the sampleclock output rate when the HPI_SAMPLECLOCK_SOURCE_LOCAL source is selected. | |
| hpi_err_t | HPI_SampleClock_SetLocalRateEx (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwSampleRateHz, uint32_t dwSampleRatePPB) |
| Set the samplerate of the sample clock's local PLL in Hz and parts per billion. | |
| hpi_err_t | HPI_SampleClock_GetLocalRate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwSampleRate) |
| Get the samplerate of the sample clock's local PLL. | |
| hpi_err_t | HPI_SampleClock_GetSampleRate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwSampleRate) |
| Gets the current adapter samplerate. | |
| hpi_err_t | HPI_SampleClock_SetAuto (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwEnable) |
| Enable/disable clock autoswitching. | |
| hpi_err_t | HPI_SampleClock_GetAuto (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwEnable) |
| hpi_err_t | HPI_SampleClock_SetLocalRateLock (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwLock) |
| Enable/disable local rate changing. | |
| hpi_err_t | HPI_SampleClock_GetLocalRateLock (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwLock) |
| hpi_err_t | HPI_ToneDetector_GetFrequency (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t nIndex, uint32_t *dwFrequency) |
| Enumerate the detection frequencies of the tone detector control. | |
| hpi_err_t | HPI_ToneDetector_GetState (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *state) |
| Get tone detector state. | |
| hpi_err_t | HPI_ToneDetector_SetEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t enable) |
| Enable (or disable) a ToneDetector control. | |
| hpi_err_t | HPI_ToneDetector_GetEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *enable) |
| Get the Enable state of a ToneDetector control. | |
| hpi_err_t | HPI_ToneDetector_SetEventEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t EventEnable) |
| Enable ToneDetector control event generation. | |
| hpi_err_t | HPI_ToneDetector_GetEventEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *EventEnable) |
| Get the event generation enable state of a ToneDetector control. | |
| hpi_err_t | HPI_ToneDetector_SetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, int threshold) |
| Set the Threshold of a ToneDetector control. | |
| hpi_err_t | HPI_ToneDetector_GetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, int *threshold) |
| Get the Threshold of a ToneDetector control. | |
| hpi_err_t | HPI_SilenceDetector_GetState (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *state) |
| Get the State of a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_SetEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t enable) |
| Enable a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_GetEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *enable) |
| Get the Enable setting of a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_SetEventEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t EventEnable) |
| Set the event generation by a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_GetEventEnable (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *EventEnable) |
| Get the event generation enable setting of a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_SetDelay (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t delay) |
| Set the Delay of a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_GetDelay (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *delay) |
| Get the trigger delay of a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_SetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, int threshold) |
| Set the Threshold of a SilenceDetector control. | |
| hpi_err_t | HPI_SilenceDetector_GetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, int *threshold) |
| Get the Threshold of a SilenceDetector control. | |
| hpi_err_t | HPI_Tuner_QueryBand (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hTuner, const uint32_t dwIndex, uint16_t *pwBand) |
| Query tuner for supported bands. | |
| hpi_err_t | HPI_Tuner_SetBand (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wBand) |
| Set the band that the tuner recieves. | |
| hpi_err_t | HPI_Tuner_GetBand (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwBand) |
| Get the current tuner band. | |
| hpi_err_t | HPI_Tuner_QueryFrequency (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hTuner, const uint32_t dwIndex, const uint16_t band, uint32_t *pdwFreq) |
| Query tuner band for supported frequency range and steps Calling with dwIndex=0,1,2 returns frequency minimum, maximum and step respectively (in kHz), for the specified band. | |
| hpi_err_t | HPI_Tuner_SetFrequency (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t wFreqInkHz) |
| Set the tuner frequency. | |
| hpi_err_t | HPI_Tuner_GetFrequency (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pwFreqInkHz) |
| Get the current tuner frequency. | |
| hpi_err_t | HPI_Tuner_QueryGain (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hTuner, const uint32_t dwIndex, uint16_t *pwGain) |
| Query possible settings of tuner gain control Iterate dwIndex until an error is returned to get the list of gains supported by this tuner. | |
| hpi_err_t | HPI_Tuner_SetGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short nGain) |
| Set the RF attenuator gain of the tuner front end. | |
| hpi_err_t | HPI_Tuner_GetGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *pnGain) |
| Get the current tuner gain. | |
| hpi_err_t | HPI_Tuner_GetRFLevel (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *pwLevel) |
| Get the RF level of a tuner input in millibel microvolts. | |
| hpi_err_t | HPI_Tuner_GetRawRFLevel (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *pwLevel) |
| Get the RF raw level of a tuner. | |
| hpi_err_t | HPI_Tuner_QueryDeemphasis (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hTuner, const uint32_t dwIndex, const uint16_t band, uint32_t *pdwDeemphasis) |
| Query tuner band for supported deemphasis settings. | |
| hpi_err_t | HPI_Tuner_SetDeemphasis (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwDeemphasis) |
| Set the audio de-emphasis. | |
| hpi_err_t | HPI_Tuner_GetDeemphasis (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwDeemphasis) |
| Get the audio de-emphasis setting. | |
| hpi_err_t | HPI_Tuner_QueryProgram (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hTuner, uint32_t *pbitmapProgram) |
| Get list of the HD Radio programs supported by this tuner as a bitfield. | |
| hpi_err_t | HPI_Tuner_SetProgram (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwProgram) |
| Sets the tuner HD Radio program. | |
| hpi_err_t | HPI_Tuner_GetProgram (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwProgram) |
| Gets the tuner HD Radio program. | |
| hpi_err_t | HPI_Tuner_GetHdRadioDspVersion (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszDspVersion, const uint32_t dwStringSize) |
| Gets the DSP firmware verison of an HD Radio tuner. | |
| hpi_err_t | HPI_Tuner_GetHdRadioSdkVersion (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszSdkVersion, const uint32_t dwStringSize) |
| Gets the SDK firmware verison of an HD Radio tuner. | |
| hpi_err_t | HPI_Tuner_GetFirmwareVersion (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszFWVersion, const uint32_t dwStringSize) |
| Gets the Firmware firmware verison of a HD or DAB Radio tuner. | |
| hpi_err_t | HPI_Tuner_GetStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *pwStatusMask, uint16_t *pwStatus) |
| Get the status of various Boolean attributes of a tuner control. | |
| hpi_err_t | HPI_Tuner_SetMode (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t nMode, uint32_t nValue) |
| This function turns off the RSS (FM FR level reading) capability for the specified tuner. | |
| hpi_err_t | HPI_Tuner_GetMode (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t nMode, uint32_t *pnValue) |
| Get the current tuner mode. | |
| hpi_err_t | HPI_Tuner_GetHdRadioSignalQuality (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwQuality) |
| Get the digital signal quality from an HDRadio tuner. | |
| hpi_err_t | HPI_Tuner_GetHdRadioSignalBlend (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwBlend) |
| Get the signal blend from an HDRadio tuner. | |
| hpi_err_t | HPI_Tuner_SetHdRadioSignalBlend (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, const uint32_t dwBlend) |
| Set the signal blend from an HDRadio tuner. | |
| hpi_err_t | HPI_Tuner_SetDabAudioService (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, const uint32_t dwIndex) |
| Sets the DAB audio service. | |
| hpi_err_t | HPI_Tuner_GetDabAudioServiceName (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszAudioServiceName, const uint32_t dwStringSize, const uint32_t nIndex) |
| Gets the DAB audio service name. | |
| hpi_err_t | HPI_Tuner_GetDabAudioServiceCount (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwIndex, uint32_t *pdwCount) |
| Gets the number of DAB audio services. | |
| hpi_err_t | HPI_Tuner_GetDabMultiplexName (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszMultiplexName, const uint32_t dwStringSize) |
| Gets the DAB Multiplex name. | |
| hpi_err_t | HPI_Tuner_GetDabAudioInfo (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszInfo, const uint32_t dwStringSize) |
| Gets the current DAB audio service information - bitrate, mode etc. | |
| hpi_err_t | HPI_Tuner_GetDabServiceInfo (hpi_handle_t hControl, unsigned int index, struct hpi_dab_service_info *service_info) |
| Get DAB service info. | |
| hpi_err_t | HPI_Tuner_GetDabComponentInfo (hpi_handle_t hControl, uint32_t service_id, uint16_t component_id, struct hpi_dab_component_info *component_info) |
| Get DAB component info. | |
| hpi_err_t | HPI_Tuner_GetDabDataPacket (hpi_handle_t hControl, char *buffer, const size_t buf_len, size_t *data_len, int *next_poll_interval_ms) |
| Get DAB data packet. | |
| hpi_err_t | HPI_Tuner_SetDabService (hpi_handle_t hControl, uint32_t service_id, uint16_t component_id, int start) |
| Start or stop a DAB data service. | |
| hpi_err_t | HPI_Tuner_GetDabService (hpi_handle_t hControl, uint32_t *service_id, uint16_t *component_id) |
| Get the currently selected Audio service. | |
| hpi_err_t | HPI_Tuner_GetRDS (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pData) |
| Get tuner RDS data. | |
| hpi_err_t | HPI_PAD_GetChannelName (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszString, const uint32_t dwDataLength) |
| Get an tuners's HD-Radio station name. | |
| hpi_err_t | HPI_PAD_GetArtist (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszString, const uint32_t dwDataLength) |
| Get tuner's PAD artist information. | |
| hpi_err_t | HPI_PAD_GetTitle (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszString, const uint32_t dwDataLength) |
| Get tuner's PAD title information. | |
| hpi_err_t | HPI_PAD_GetComment (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, char *pszString, const uint32_t dwDataLength) |
| Get tuner's PAD comment information. | |
| hpi_err_t | HPI_PAD_GetProgramType (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwPTY) |
| Get tuner's PAD program type (PTY). | |
| hpi_err_t | HPI_PAD_GetRdsPI (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *pdwPI) |
| Get tuner's PAD RDS program identification (PI). | |
| hpi_err_t | HPI_PAD_GetProgramTypeString (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, const uint32_t dwDataType, const uint32_t nPTY, char *pszData, const uint32_t dwDataLength) |
| Translate tuner's PTY into a string. | |
| hpi_err_t | HPI_Volume_QueryChannels (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hVolume, uint32_t *pChannels) |
| Get the number of channels supported by this volume control. | |
| hpi_err_t | HPI_VolumeSetGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anLogGain[HPI_MAX_CHANNELS]) |
| Set the gain of a volume control. | |
| hpi_err_t | HPI_VolumeGetGain (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anLogGain[HPI_MAX_CHANNELS]) |
| Gets the current gain of a volume control. | |
| hpi_err_t | HPI_VolumeSetMute (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t mute) |
| Set the mute of a volume control. | |
| hpi_err_t | HPI_VolumeGetMute (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t *mute) |
| Gets the current mute setting of a volume control. | |
| hpi_err_t | HPI_VolumeQueryRange (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *nMinGain_01dB, short *nMaxGain_01dB, short *nStepGain_01dB) |
| Query the range of a volume or level control. | |
| hpi_err_t | HPI_VolumeAutoFadeProfile (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anStopGain0_01dB[HPI_MAX_CHANNELS], uint32_t dwDurationMs, uint16_t wProfile) |
| Starts an automatic ramp of the volume control from the current gain setting to the specified setting over the specified duration (in milliseconds). | |
| hpi_err_t | HPI_VolumeAutoFade (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anStopGain0_01dB[HPI_MAX_CHANNELS], uint32_t dwDurationMs) |
| hpi_err_t | HPI_Volume_QueryAutoFadeProfile (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hVolume, const uint32_t i, uint16_t *wProfile) |
| Enumerate autofade profiles supported by this controls (may be none). | |
| hpi_err_t | HPI_VoxSetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short anGain0_01dB) |
| Sets the threshold of a VOX control. | |
| hpi_err_t | HPI_VoxGetThreshold (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, short *anGain0_01dB) |
| Gets the current threshold of a VOX control. | |
| hpi_err_t | HPI_Universal_Info (const hpi_hsubsys_t *phSubSys, hpi_handle_t hC, struct hpi_entity **info) |
| Retrieve information associated with an universal control. | |
| hpi_err_t | HPI_Universal_Get (const hpi_hsubsys_t *phSubSys, hpi_handle_t hC, struct hpi_entity **value) |
| Returns the current value of an universal control as an entity. | |
| hpi_err_t | HPI_Universal_Set (const hpi_hsubsys_t *phSubSys, hpi_handle_t hC, struct hpi_entity *value) |
| Set the current value of an universal control. | |
| hpi_err_t | HPI_GpioOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, hpi_handle_t *phGpio, uint16_t *pwNumberInputBits, uint16_t *pwNumberOutputBits) |
| Opens the GPIO on a particular adapter for reading and writing. | |
| hpi_err_t | HPI_GpioReadBit (const hpi_hsubsys_t *phSubSys, hpi_handle_t hGpio, uint16_t wBitIndex, uint16_t *pwBitData) |
| Read a particular bit from an adapter's GPIO input port. | |
| hpi_err_t | HPI_GpioReadAllBits (const hpi_hsubsys_t *phSubSys, hpi_handle_t hGpio, uint16_t awAllBitData[4]) |
| Read all bits from an adapter's GPIO input ports. | |
| hpi_err_t | HPI_GpioWriteBit (const hpi_hsubsys_t *phSubSys, hpi_handle_t hGpio, uint16_t wBitIndex, uint16_t wBitData) |
| Write a particular bit to an adapter's GPIO output port. | |
| hpi_err_t | HPI_GpioWriteStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hGpio, uint16_t awAllBitData[4]) |
| Read back the current status of all GPIO outputs on an adapter. | |
| hpi_err_t | HPI_NvMemoryOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, hpi_handle_t *phNvMemory, uint16_t *pwSizeInBytes) |
| Opens the non-volatile memory on a particular adapter for reading and writing. | |
| hpi_err_t | HPI_NvMemoryReadByte (const hpi_hsubsys_t *phSubSys, hpi_handle_t hNvMemory, uint16_t wIndex, uint16_t *pwData) |
| Reads a byte from an adapters non-volatile memory. | |
| hpi_err_t | HPI_NvMemoryWriteByte (const hpi_hsubsys_t *phSubSys, hpi_handle_t hNvMemory, uint16_t wIndex, uint16_t wData) |
| Writes a byte to an adapters non-volatile memory. | |
| hpi_err_t | HPI_ProfileOpenAll (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wProfileIndex, hpi_handle_t *phProfile, uint16_t *pwMaxProfiles) |
| Open all the profiles on a particular adapter. | |
| hpi_err_t | HPI_ProfileGet (const hpi_hsubsys_t *phSubSys, hpi_handle_t hProfile, uint16_t wBinIndex, uint16_t *pwProfileInterval, uint32_t *pdwTotalTickCount, uint32_t *pdwCallCount, uint32_t *pdwMaxTickCount, uint32_t *pdwTicksPerMillisecond) |
| Reads a single profile from the DSP's profile store. | |
| hpi_err_t | HPI_ProfileGetUtilization (const hpi_hsubsys_t *phSubSys, hpi_handle_t hProfile, uint32_t *pdwUtilization) |
| Get the DSP utilization in 1/100 of a percent. | |
| hpi_err_t | HPI_ProfileGetName (const hpi_hsubsys_t *phSubSys, hpi_handle_t hProfile, uint16_t wBinIndex, char *szName, uint16_t nNameLength) |
| Get the name of a profile. | |
| hpi_err_t | HPI_ProfileStartAll (const hpi_hsubsys_t *phSubSys, hpi_handle_t hProfile) |
| Start profiling running. | |
| hpi_err_t | HPI_ProfileStopAll (const hpi_hsubsys_t *phSubSys, hpi_handle_t hProfile) |
| Stop profiling. | |
Hardware Programming Interface (HPI) functions.
| hpi_handle_t HPI_IndexesToHandle | ( | const char | cObject, |
| const uint16_t | wAdapterIndex, | ||
| const uint16_t | wObjectIndex | ||
| ) |
Encode 3 indices and an object type into a 32 bit handle.
| cObject | HPI_OBJ_* - the type code of object |
| wAdapterIndex | The Adapter index |
| wObjectIndex | The stream or control index, if used |
References hpi_handle::adapterIndex, hpi_handle::objIndex, hpi_handle::objType, and hpi_handle::readOnly.
Referenced by HPI_GpioOpen(), HPI_InStreamOpen(), HPI_MixerGetControl(), HPI_MixerGetControlByIndex(), HPI_MixerOpen(), HPI_NvMemoryOpen(), HPI_Object_BlockHandle(), HPI_Object_ParameterHandle(), HPI_Object_UriToHandle(), HPI_OutStreamOpen(), and HPI_ProfileOpenAll().
| void HPI_HandleToIndexes | ( | const hpi_handle_t | dwHandle, |
| uint16_t * | pwAdapterIndex, | ||
| uint16_t * | pwObjectIndex | ||
| ) |
| dwHandle | The handle to decode |
| pwAdapterIndex | return the Adapter index |
| pwObjectIndex | return the stream or control index |
1.7.3