Handset.h

Go to the documentation of this file.

#ifndef _TIPRO_TIPROHIDAPI_HANDSET_H_
#define _TIPRO_TIPROHIDAPI_HANDSET_H_

#include "TiproHidDevice.h"

#ifdef __cplusplus
extern "C" {
#endif

/****************************************************************************/
/*      HANDSET DEFINES                                                  */
/****************************************************************************/

// microphone level (attenuation)
#define HXX_MIC_ATT_0                   0x00 
#define HXX_MIC_ATT_1                   0x01 
#define HXX_MIC_ATT_2                   0x02 
#define HXX_MIC_ATT_3                   0x03 
#define HXX_MIC_ATT_4                   0x04 
#define HXX_MIC_ATT_5                   0x05 
#define HXX_MIC_ATT_6                   0x06 
#define HXX_MIC_ATT_7                   0x07 
#define HXX_MIC_ATT_8                   0x08 
#define HXX_MIC_ATT_9                   0x09 
#define HXX_MIC_ATT_10                  0x0A 
#define HXX_MIC_ATT_11                  0x0B 
#define HXX_MIC_ATT_12                  0x0C 
#define HXX_MIC_ATT_13                  0x0D 
#define HXX_MIC_ATT_14                  0x0E 
// paramters limited to usefull range
#define HXX_MIC_ATT_MIN                 HXX_MIC_ATT_0
#define HXX_MIC_ATT_MAX                 HXX_MIC_ATT_14

// microphone compression settings
#define HXX_MIC_COMPRESSION_OFF         0x10 
#define HXX_MIC_COMPRESSION_ON          0x11 
#define HXX_MIC_COMPRESSION_MIN             HXX_MIC_COMPRESSION_OFF
#define HXX_MIC_COMPRESSION_MAX             HXX_MIC_COMPRESSION_ON

// microphone noise threshold
#define HXX_MIC_THRESHOLD_HIGH          0x10 
#define HXX_MIC_THRESHOLD_MID           0x11 
#define HXX_MIC_THRESHOLD_LOW           0x12 
#define HXX_MIC_THRESHOLD_LOWER         0x13 
#define HXX_MIC_THRESHOLD_VERY_LOW      0x14 
#define HXX_MIC_THRESHOLD_ILLEGAL       0xFF

#define HXX_MIC_THRESHOLD_MIN               HXX_MIC_THRESHOLD_HIGH
#define HXX_MIC_THRESHOLD_MAX               HXX_MIC_THRESHOLD_VERY_LOW


// speaker
#define HXX_SPEAKER_LEVEL_P2            0x00 
#define HXX_SPEAKER_LEVEL_P1            0x01 
#define HXX_SPEAKER_LEVEL_0             0x02 
#define HXX_SPEAKER_LEVEL_M1            0x03 
#define HXX_SPEAKER_LEVEL_M2            0x04 
#define HXX_SPEAKER_LEVEL_M3            0x05 
#define HXX_SPEAKER_LEVEL_M4            0x06 
#define HXX_SPEAKER_LEVEL_M5            0x07 
#define HXX_SPEAKER_LEVEL_M6            0x08 
#define HXX_SPEAKER_LEVEL_M7            0x09 
#define HXX_SPEAKER_LEVEL_M8            0x0A 
#define HXX_SPEAKER_LEVEL_ILLEGAL       0xFF

#define HXX_SPEAKER_LEVEL_MIN   HXX_SPEAKER_LEVEL_P2
#define HXX_SPEAKER_LEVEL_MAX   HXX_SPEAKER_LEVEL_M8

/* Special features not available in API */
#define HXX_SPEAKER_MUTE                0xF3
#define HXX_SPEAKER_RESTORE             0xF4


/****************************************************************************/
/*      Handset functions                                                   */
/****************************************************************************/

int TiproHandsetSetMicrophoneCompression (TiproHidDevice *device, int nHandsetNum, int nCompression);

int TiproHandsetSetMicrophoneThreshold (TiproHidDevice *device, int nHandsetNum, int nThreshold);

int TiproHandsetSetMicrophoneLevel (TiproHidDevice *device, int nHandsetNum, int nLevel);

int TiproHandsetGetMicrophoneCompression (TiproHidDevice *device, int nHandsetNum, int *nCompression);

int TiproHandsetGetMicrophoneThreshold (TiproHidDevice *device, int nHandsetNum, int *nThreshold);

int TiproHandsetGetMicrophoneLevel (TiproHidDevice *device, int nHandsetNum, int *nLevel);

int TiproHandsetSetSpeakerLevel(TiproHidDevice *device, int nHandsetNum, int nLevel);

int TiproHandsetGetSpeakerLevel(TiproHidDevice *device, int nHandsetNum, int *nLevel);

#ifdef __cplusplus
}
#endif

#endif