Tipro API
Communicate with Tipro devices
SpeakerBox_IntFn.h
1 // SpeakerBox_IntFn.h :
3 
4 
5 #include "TiproHidDevice.h" //20190712
6 #include "SpeakerBox.h"
7 
9 // SpeakerBox internal functions
10 
11 int intFn_HIDGetHandsetState (TiproHidDevice *device, int nAddress, int *nPTTKey, int *nHookState);
12 int intFn_HIDGetHandsetStateEx (TiproHidDevice *device, int nAddress, int *nPTTKey, int *nHookState);
13 int intFn_HIDSetSpeakerLevel(TiproHidDevice *device, int nAddress, int nLevel);
14 int intFn_HIDGetSpeakerLevel(TiproHidDevice *device, int nAddress, int *nLevel);
15 int intFn_HIDGetSbxKeyState (TiproHidDevice *device, int nAddress, int nKey, int *nState);
16 int intFn_HIDSetSbxLEDState (TiproHidDevice *device, int nAddress, int nKey, int nState);
17 int intFn_HIDGetSbxLEDState (TiproHidDevice *device, int nAddress, int nKey, int *nState);
18 int intFn_HIDSetExternalDeviceLevel (TiproHidDevice *device, int nAddress, int nLevel);
19 int intFn_HIDGetExternalDeviceLevel (TiproHidDevice *device, int nAddress, int *nLevel);
20 int intFn_HIDGetExternalHeadsetState (TiproHidDevice *device, int nAddress, int *nState);
21 int intFn_HIDMuteMicrophone (TiproHidDevice *device, int nAddress, int nMute);
22 //int intFn_HIDSetSbxLedsState(int nAddress, int nLeds);//tomaz20170329 set state (on/off) of all leds with one command
23 
24 
25 // new generic version of microphone setting commands
26 #if 1
27 int intFn_HIDSetMicrophoneThreshold (TiproHidDevice *device, int nAddress, int nThreshold, int nDevice=SBX_DEVICE_HANDSFREE_HANDSET_HEADSET);
28 int intFn_HIDSetMicrophoneCompression (TiproHidDevice *device, int nAddress, int nCompression, int nDevice=SBX_DEVICE_HANDSFREE_HANDSET_HEADSET);
29 int intFn_HIDSetMicrophoneOptimalDistance (TiproHidDevice *device, int nAddress, int nDistance);
30 int intFn_HIDGetMicrophoneOptimalDistance (TiproHidDevice *device, int nAddress, int *nDistance);
31 int intFn_HIDSetMicrophoneLevel (TiproHidDevice *device, int nAddress, int nLevel, int nDevice=SBX_DEVICE_HANDSFREE_HANDSET_HEADSET);
32 #endif
33 
34 // Get functions with nDevice parameter that is not used as FW doesn't yet support this (RFU)
35 #if 1
36 int intFn_HIDGetMicrophoneThreshold (TiproHidDevice *device, int nAddress, int *nThreshold, int nDevice=SBX_DEVICE_HANDSFREE_HANDSET_HEADSET);
37 int intFn_HIDGetMicrophoneCompression (TiproHidDevice *device, int nAddress, int *nCompression, int nDevice=SBX_DEVICE_HANDSFREE_HANDSET_HEADSET);
38 int intFn_HIDGetMicrophoneLevel (TiproHidDevice *device, int nAddress, int *nLevel, int nDevice=SBX_DEVICE_HANDSFREE_HANDSET_HEADSET);
39 #endif
40 
41 
42 // Task#98
43 // Blink functionality available on FW version >5.xx.61
44 // int intFn_HIDSetLedBlink(int nAddress, int nKey, int nBlink); -> intFn_HIDSetSbxLEDState used instead of special function
45 // int intFn_HIDGetLedBlink(int nAddress, int nKey, int *nBlink); -> intFn_HIDGetSbxLEDState used instead of special function
46 int intFn_HIDSetSbxLEDBlinkSpeed (TiproHidDevice *device, int nAddress, int nTBlinkA, int nTBlinkB);
47 int intFn_HIDGetSbxLEDBlinkSpeed (TiproHidDevice *device, int nAddress, int *nTBlinkA, int *nTBlinkB);
48 
49 
51 // BF10 Speakerbox specific functions
52 
53 int intFn_HIDSetLuminanceAndSync (TiproHidDevice *device, int nAddressBF, int nAddressSbx, int nIndex);
54 int intFn_HIDSetStripeLuminance (TiproHidDevice *device, int nAddress, int nIndex);
55 int intFn_HIDSetBFLuminance (TiproHidDevice *device, int nAddress, int nIndex);
56 int intFn_HIDGetBF10Luminance (TiproHidDevice *device, int nAddress, int* nIndex, int* nIx10, int* nAutoMode);
57 int intFn_HIDSetPTTLed (TiproHidDevice *device, int nAddress, int nMode, int TBlinkA, int TBlinkB, bool bStoreBlinkInEEP);
58 int intFn_HIDGetPTTLed (TiproHidDevice *device, int nAddress, int *nMode, int *TBlinkA, int *TBlinkB);
59 int intFn_HIDSetStripeLuminanceAuto (TiproHidDevice *device, int nAddress, int nAutoMode);
60 int intFn_HIDSetBFLuminanceAuto (TiproHidDevice *device, int nAddress, int nAutoMode);
61 int intFn_HIDSetLuminanceAuto(TiproHidDevice *device, int nAddressBF,int nAddressSbx,int nAutoMode);
62 
63 int intFn_HIDSetAnalogAudio (TiproHidDevice *device, int nAddress, int nSettings);
64 int intFn_HIDGetAnalogAudio (TiproHidDevice *device, int nAddress, int* nSettings);
65 int intFn_HIDShowOnVuMeter (TiproHidDevice *device, int nAddress, int nIndex);
66 
67 // old version of commands replaced with generic commands
68 #if 0
69 int intFn_HIDBF10SetMicrophoneProfile (TiproHidDevice *device, int nAddress, int nProfile);
70 int intFn_HIDGetMicrophoneProfile (TiproHidDevice *device, int nAddress,int *nProfile);
71 int intFn_HIDSetMicrophoneRange (TiproHidDevice *device, int nAddress, int nRange);
72 int intFn_HIDGetMicrophoneRange (TiproHidDevice *device, int nAddress, int *nRange);
73 int intFn_HIDSetMicrophoneLevel (TiproHidDevice *device, int nAddress, int nLevel);
74 int intFn_HIDGetMicrophoneLevel (TiproHidDevice *device, int nAddress, int *nLevel);
75 #endif
Represents Tipro device.
Definition: TiproHidDevice.h:29