BF20.h

Go to the documentation of this file.

#ifndef _TIPRO_TIPROHIDAPI_BF20_H_
#define _TIPRO_TIPROHIDAPI_BF20_H_

#include "TiproHidDevice.h"

#ifdef __cplusplus
extern "C" {
#endif

/****************************************************************************/
/*      BF20 DEFINES                                                        */
/****************************************************************************/

// PCM scenario
#define BF20_PCM_SCENARIO_AB            0x3C 
#define BF20_PCM_SCENARIO_LR            0x3D 
#define BF20_PCM_SCENARIO_VOID          0x3F
#define BF20_PCM_SCENARIO_MASK          0x03

// microphone amplifier mode
#define BF20_MICAMP_MODE_LOG            0x33 
#define BF20_MICAMP_MODE_LIN            0x37 
#define BF20_MICAMP_MODE_VOID           0x3F
#define BF20_MICAMP_MODE_MASK           0x0C

// central (low frequency) speaker 
#define BF20_LF_SPK_OFF                 0x3C 
#define BF20_LF_SPK_ON                  0x3D 
#define BF20_LF_SPK_VOID                0x3F
#define BF20_LF_SPK_MASK                0x03

// showing microphone signal on VU meter
#define BF20_VU_AB_MIC_OFF              0x33 
#define BF20_VU_AB_MIC_ON               0x37 
#define BF20_VU_AB_MIC_VOID             0x3F
#define BF20_VU_AB_MIC_MASK             0x0C

// analog line out to speakers
#define BF20_LINE_OUT_OFF_SPK           0x10 
#define BF20_LINE_OUT_ON_L_SPK          0x11 
#define BF20_LINE_OUT_ON_R_SPK          0x12 
#define BF20_LINE_OUT_ON_LR_SPK         0x13 
#define BF20_LINE_OUT_VOID              0x14
#define BF20_LINE_OUT_MASK              0x03

// microphone to analog line in
#define BF20_MIC_OFF_LINE_IN            0x04 
#define BF20_MIC_ON_LINE_IN             0x0C 
#define BF20_MIC_LINE_IN_VOID           0x14
#define BF20_MIC_LINE_IN_MASK           0x08

// echo canceller
#define BF20_EC_OFF                     0x00 
#define BF20_EC_ON_L                    0x01 
#define BF20_EC_ON_R                    0x02 
#define BF20_EC_ON_LR                   0x03 
#define BF20_EC_VOID                    0x07
#define BF20_EC_MASK                    0x03

// PTT LED controll
#define BF20_PTT_LED_OFF                0x00 
#define BF20_PTT_LED_ON                 0x10 
#define BF20_PTT_LED_BLINK              0x20 
// microphone
#define BF20_MIC_ACTIVE                 0x00 
#define BF20_MIC_MUTE                   0x01 
// microphone level (attenuation)
#define BF20_MIC_LEVEL_P3               0x10 
#define BF20_MIC_LEVEL_P2               0x11 
#define BF20_MIC_LEVEL_P1               0x12 
#define BF20_MIC_LEVEL_0                0x13 
#define BF20_MIC_LEVEL_M1               0x14 
#define BF20_MIC_LEVEL_M2               0x15 
#define BF20_MIC_LEVEL_M3               0x16 
#define BF20_MIC_LEVEL_M4               0x17 
#define BF20_MIC_LEVEL_M5               0x18 
#define BF20_MIC_LEVEL_M6               0x19 
#define BF20_MIC_LEVEL_M7               0x1A 
#define BF20_MIC_LEVEL_M8               0x1B 
#define BF20_MIC_LEVEL_M9               0x1C 
#define BF20_MIC_LEVEL_M10              0x1D 
#define BF20_MIC_LEVEL_M11              0x1E 
#define BF20_MIC_LEVEL_MIN              BF20_MIC_LEVEL_P3
#define BF20_MIC_LEVEL_MAX              BF20_MIC_LEVEL_M11

// microphone optimal distance
#define BF20_MIC_DISTANCE_M2            0x0A 
#define BF20_MIC_DISTANCE_M1            0x0B 
#define BF20_MIC_DISTANCE_0             0x0C 
#define BF20_MIC_DISTANCE_P1            0x0D 
#define BF20_MIC_DISTANCE_P2            0x0E 
#define BF20_MIC_DISTANCE_P3            0x0F 
#define BF20_MIC_DISTANCE_P4            0x10 
#define BF20_MIC_DISTANCE_P5            0x11 
#define BF20_MIC_DISTANCE_P6            0x12 
#define BF20_MIC_DISTANCE_P7            0x13 
#define BF20_MIC_DISTANCE_P8            0x14 
#define BF20_MIC_DISTANCE_VERY_SHORT    BF20_MIC_DISTANCE_0 
#define BF20_MIC_DISTANCE_SHORT         BF20_MIC_DISTANCE_P2 
#define BF20_MIC_DISTANCE_MEDIUM        BF20_MIC_DISTANCE_P4 
#define BF20_MIC_DISTANCE_LONG          BF20_MIC_DISTANCE_P6 
#define BF20_MIC_DISTANCE_MIN           BF20_MIC_DISTANCE_M2
#define BF20_MIC_DISTANCE_MAX           BF20_MIC_DISTANCE_P8

// microphone compression
#define BF20_MIC_COMPRESSION_OFF        0x10 
#define BF20_MIC_COMPRESSION_ON         0x11 
#define BF20_MIC_COMPRESSION_MIN        BF22_MIC_COMPRESSION_OFF
#define BF20_MIC_COMPRESSION_MAX        BF22_MIC_COMPRESSION_ON

// microphone noise threshold
#define BF20_MIC_THRESHOLD_HIGH         0x10 
#define BF20_MIC_THRESHOLD_MID          0x11 
#define BF20_MIC_THRESHOLD_LOW          0x12 
#define BF20_MIC_THRESHOLD_LOWER        0x13 
#define BF20_MIC_THRESHOLD_VERY_LOW     0x14 
#define BF20_MIC_THRESHOLD_MIN          BF22_MIC_THRESHOLD_HIGH
#define BF20_MIC_THRESHOLD_MAX          BF22_MIC_THRESHOLD_VERY_LOW

//luminance
#define BF20_LUMINANCE_MIN              0x00 
#define BF20_LUMINANCE_MAX              0x14 
//speaker level
#define BF20_SPK_LEVEL_MIN              0x00 
#define BF20_SPK_LEVEL_MAX              0x14 
/****************************************************************************/
/*      BF20 FUNCTIONS                                                      */
/****************************************************************************/

int TiproBF20SetPCMScenario(TiproHidDevice *device, int nScenario);

int TiproBF20GetPCMScenario(TiproHidDevice *device, int *nScenario, int *nInitScenario);

int TiproBF20SetMicAmpMode(TiproHidDevice *device, int nMicAmpMode);

int TiproBF20GetMicAmpMode(TiproHidDevice *device, int *nMicAmpMode, int *nInitMicAmpMode);

int TiproBF20SetLFSpeakerState(TiproHidDevice *device, int nState);

int TiproBF20GetLFSpeakerState(TiproHidDevice *device, int *nState, int *nInitState);

int TiproBF20SetMicOnVUState(TiproHidDevice *device, int nState);

int TiproBF20GetMicOnVUState(TiproHidDevice *device, int *nState, int *nInitState);

int TiproBF20SetMic2LineInState(TiproHidDevice *device, int nState);

int TiproBF20GetMic2LineInState(TiproHidDevice *device, int *nState, int *nInitState);

int TiproBF20SetLineOut2SpkMode(TiproHidDevice *device, int nMode);

int TiproBF20GetLineOut2SpkMode(TiproHidDevice *device, int *nMode, int *nInitMode);

int TiproBF20SetEchoMode(TiproHidDevice *device, int nMode);

int TiproBF20GetEchoMode(TiproHidDevice *device, int *nMode, int *nInitMode);

int TiproBF20TouchscreenDisable(TiproHidDevice *device);

int TiproBF20TouchscreenEnable(TiproHidDevice *device);

int TiproBF20SetPTTKeyLEDState(TiproHidDevice *device, int nState);

int TiproBF20SetPTTKeyLEDStateEx(TiproHidDevice *device, int nState, int nTBlinkOn, int nTBlinkOff);

int TiproBF20GetPTTKeyLEDState(TiproHidDevice *device, int *nState);

int TiproBF20MuteMicrophone(TiproHidDevice *device, int nMute);

int TiproBF20SetLeftSpeakerLevel(TiproHidDevice *device, int nLevel);

int TiproBF20GetLeftSpeakerLevel(TiproHidDevice *device, int *nLevel);

int TiproBF20SetRightSpeakerLevel(TiproHidDevice *device, int nLevel);

int TiproBF20GetRightSpeakerLevel(TiproHidDevice *device, int *nLevel);

int TiproBF20SetMicrophoneLevel(TiproHidDevice *device, int nLevel, bool bSetInit);

int TiproBF20GetMicrophoneLevel(TiproHidDevice *device, int *nLevel, int *nInitLevel);

int TiproBF20SetMicrophoneOptimalDistance(TiproHidDevice *device, int nDistance, bool bSetInit);

int TiproBF20GetMicrophoneOptimalDistance(TiproHidDevice *device, int *nDistance, int *nInitDistance);

int TiproBF20GetMicrophoneThreshold(TiproHidDevice *device, int *nThreshold, int *nInitThreshold);

int TiproBF20SetMicrophoneThreshold(TiproHidDevice *device, int nThreshold, bool bSetInit);

int TiproBF20GetMicrophoneCompression(TiproHidDevice *device, int *nCompression, int *nInitCompression);

int TiproBF20SetMicrophoneCompression(TiproHidDevice *device, int nCompression, bool bSetInit);

int TiproBF20GetLuminance(TiproHidDevice *device, int *nLuminance);

int TiproBF20SetLuminance(TiproHidDevice *device, int nLuminance);

int TiproBF20GetPTTKeyState(TiproHidDevice *device, int *nState);

#ifdef __cplusplus
}
#endif

#endif