Tipro API
Communicate with Tipro devices
Macros | Functions
BF20.h File Reference
#include "TiproHidDevice.h"
Include dependency graph for BF20.h:

Go to the source code of this file.

Macros

#define BF20_PCM_SCENARIO_AB   0x3C
 
#define BF20_PCM_SCENARIO_LR   0x3D
 
#define BF20_PCM_SCENARIO_VOID   0x3F
 
#define BF20_PCM_SCENARIO_MASK   0x03
 
#define BF20_MICAMP_MODE_LOG   0x33
 
#define BF20_MICAMP_MODE_LIN   0x37
 
#define BF20_MICAMP_MODE_VOID   0x3F
 
#define BF20_MICAMP_MODE_MASK   0x0C
 
#define BF20_LF_SPK_OFF   0x3C
 
#define BF20_LF_SPK_ON   0x3D
 
#define BF20_LF_SPK_VOID   0x3F
 
#define BF20_LF_SPK_MASK   0x03
 
#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
 
#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
 
#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
 
#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
 
#define BF20_PTT_LED_OFF   0x00
 
#define BF20_PTT_LED_ON   0x10
 
#define BF20_PTT_LED_BLINK   0x20
 
#define BF20_MIC_ACTIVE   0x00
 
#define BF20_MIC_MUTE   0x01
 
#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
 
#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
 
#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
 
#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
 
#define BF20_LUMINANCE_MIN   0x00
 
#define BF20_LUMINANCE_MAX   0x14
 
#define BF20_SPK_LEVEL_MIN   0x00
 
#define BF20_SPK_LEVEL_MAX   0x14
 

Functions

int TiproBF20SetPCMScenario (TiproHidDevice *device, int nScenario)
 Set PCM scenario. More...
 
int TiproBF20GetPCMScenario (TiproHidDevice *device, int *nScenario, int *nInitScenario)
 Get PCM scenario. More...
 
int TiproBF20SetMicAmpMode (TiproHidDevice *device, int nMicAmpMode)
 Set Microphone amplifier mode (Linear/Logarithmic) More...
 
int TiproBF20GetMicAmpMode (TiproHidDevice *device, int *nMicAmpMode, int *nInitMicAmpMode)
 Get Microphone amplifier mode (Linear/Logarithmic) More...
 
int TiproBF20SetLFSpeakerState (TiproHidDevice *device, int nState)
 Set LF speaker state (ON/OFF) More...
 
int TiproBF20GetLFSpeakerState (TiproHidDevice *device, int *nState, int *nInitState)
 Get LF speaker state. More...
 
int TiproBF20SetMicOnVUState (TiproHidDevice *device, int nState)
 Sets if microphone signal is shown on the VU-meter (ON/OFF) More...
 
int TiproBF20GetMicOnVUState (TiproHidDevice *device, int *nState, int *nInitState)
 Get microphone signal shown on VU-meter state. More...
 
int TiproBF20SetMic2LineInState (TiproHidDevice *device, int nState)
 Sets the connection state (ON/OFF) of the gooseneck microphone to the LINE-IN port on the motherboard. More...
 
int TiproBF20GetMic2LineInState (TiproHidDevice *device, int *nState, int *nInitState)
 Returns the connection state (ON/OFF) of the gooseneck microphone to the LINE-IN port on the motherboard. More...
 
int TiproBF20SetLineOut2SpkMode (TiproHidDevice *device, int nMode)
 Sets the connection mode (OFF/L/R/LR) of the motherboard LINE-OUT port to the speakers. More...
 
int TiproBF20GetLineOut2SpkMode (TiproHidDevice *device, int *nMode, int *nInitMode)
 Returns the connection mode (OFF/L/R/LR) of the motherboard LINE-OUT port to the speakers. More...
 
int TiproBF20SetEchoMode (TiproHidDevice *device, int nMode)
 Sets the echo canceler mode (OFF/L/R/LR) More...
 
int TiproBF20GetEchoMode (TiproHidDevice *device, int *nMode, int *nInitMode)
 Returns the echo canceler mode (OFF/L/R/LR) More...
 
int TiproBF20TouchscreenDisable (TiproHidDevice *device)
 Disables touchscreen. More...
 
int TiproBF20TouchscreenEnable (TiproHidDevice *device)
 Enables touchscreen. More...
 
int TiproBF20SetPTTKeyLEDState (TiproHidDevice *device, int nState)
 Sets the LED state of illuminated PTT key. More...
 
int TiproBF20SetPTTKeyLEDStateEx (TiproHidDevice *device, int nState, int nTBlinkOn, int nTBlinkOff)
 Sets the operation of the illuminated PTT key with more paramters. More...
 
int TiproBF20GetPTTKeyLEDState (TiproHidDevice *device, int *nState)
 Returns the LED state of the illuminated PTT Key. More...
 
int TiproBF20MuteMicrophone (TiproHidDevice *device, int nMute)
 Mutes/un-mutes the microphone signal. More...
 
int TiproBF20SetLeftSpeakerLevel (TiproHidDevice *device, int nLevel)
 Sets the level of the left speaker. More...
 
int TiproBF20GetLeftSpeakerLevel (TiproHidDevice *device, int *nLevel)
 Returns the level of the left speaker. More...
 
int TiproBF20SetRightSpeakerLevel (TiproHidDevice *device, int nLevel)
 Sets the level of the right speaker. More...
 
int TiproBF20GetRightSpeakerLevel (TiproHidDevice *device, int *nLevel)
 Returns the level of the right speaker. More...
 
int TiproBF20SetMicrophoneLevel (TiproHidDevice *device, int nLevel, bool bSetInit)
 Sets the gooseneck microphone level. More...
 
int TiproBF20GetMicrophoneLevel (TiproHidDevice *device, int *nLevel, int *nInitLevel)
 Returns the googeneck microphone level. More...
 
int TiproBF20SetMicrophoneOptimalDistance (TiproHidDevice *device, int nDistance, bool bSetInit)
 Sets the microphone optimal distance. More...
 
int TiproBF20GetMicrophoneOptimalDistance (TiproHidDevice *device, int *nDistance, int *nInitDistance)
 Gets the microphone optimal distance. More...
 
int TiproBF20GetMicrophoneThreshold (TiproHidDevice *device, int *nThreshold, int *nInitThreshold)
 Returns threshold for the microphone signal. More...
 
int TiproBF20SetMicrophoneThreshold (TiproHidDevice *device, int nThreshold, bool bSetInit)
 Sets threshold for the microphone signal. More...
 
int TiproBF20GetMicrophoneCompression (TiproHidDevice *device, int *nCompression, int *nInitCompression)
 Returns compression for the microphone signal. More...
 
int TiproBF20SetMicrophoneCompression (TiproHidDevice *device, int nCompression, bool bSetInit)
 Sets compression for the microphone signal. More...
 
int TiproBF20GetLuminance (TiproHidDevice *device, int *nLuminance)
 Returns luminance for both stripe and LCD backlight. More...
 
int TiproBF20SetLuminance (TiproHidDevice *device, int nLuminance)
 Sets luminance for both stripe and LCD backlight. More...
 
int TiproBF20GetPTTKeyState (TiproHidDevice *device, int *nState)
 Returns the state of the PTT key. More...
 

Detailed Description

BF20

This file includes functions for communication with BF20.

BeFREE 20 (BF20) is a touchcomputer with integrated intercom.

Tipro

suppo.nosp@m.rt@t.nosp@m.ipro..nosp@m.si

Copyright 2021

Macro Definition Documentation

◆ BF20_EC_OFF

#define BF20_EC_OFF   0x00

Echo canceller disabled.

◆ BF20_EC_ON_L

#define BF20_EC_ON_L   0x01

Echo canceller enabled. Left speaker signal as reference.

◆ BF20_EC_ON_LR

#define BF20_EC_ON_LR   0x03

Echo canceller enabled. Left and right speaker signal as reference.

◆ BF20_EC_ON_R

#define BF20_EC_ON_R   0x02

Echo canceller enabled. Right speaker signal as reference.

◆ BF20_LF_SPK_OFF

#define BF20_LF_SPK_OFF   0x3C

Central speaker disabled.

◆ BF20_LF_SPK_ON

#define BF20_LF_SPK_ON   0x3D

Central speaker activated.

◆ BF20_LINE_OUT_OFF_SPK

#define BF20_LINE_OUT_OFF_SPK   0x10

Soundcard is not connected to the speakers.

◆ BF20_LINE_OUT_ON_L_SPK

#define BF20_LINE_OUT_ON_L_SPK   0x11

Left channel of soundcard to left speaker.

◆ BF20_LINE_OUT_ON_LR_SPK

#define BF20_LINE_OUT_ON_LR_SPK   0x13

Left channel of soundcard to left speaker and right channel to right speaker.

◆ BF20_LINE_OUT_ON_R_SPK

#define BF20_LINE_OUT_ON_R_SPK   0x12

Right channel of soundcard to right speaker.

◆ BF20_LUMINANCE_MAX

#define BF20_LUMINANCE_MAX   0x14

LCD screen luminance 20 - maximum

◆ BF20_LUMINANCE_MIN

#define BF20_LUMINANCE_MIN   0x00

LCD screen luminance 0 - minimum

◆ BF20_MIC_ACTIVE

#define BF20_MIC_ACTIVE   0x00

Microphone is active.

◆ BF20_MIC_COMPRESSION_OFF

#define BF20_MIC_COMPRESSION_OFF   0x10

Microphone compression off

◆ BF20_MIC_COMPRESSION_ON

#define BF20_MIC_COMPRESSION_ON   0x11

Microphone compression on

◆ BF20_MIC_DISTANCE_0

#define BF20_MIC_DISTANCE_0   0x0C

Microphone preamplifier level 0

◆ BF20_MIC_DISTANCE_LONG

#define BF20_MIC_DISTANCE_LONG   BF20_MIC_DISTANCE_P6

Long distance (~200 cm)

◆ BF20_MIC_DISTANCE_M1

#define BF20_MIC_DISTANCE_M1   0x0B

Microphone preamplifier level -1

◆ BF20_MIC_DISTANCE_M2

#define BF20_MIC_DISTANCE_M2   0x0A

Microphone preamplifier level -2 (minimum)

◆ BF20_MIC_DISTANCE_MEDIUM

#define BF20_MIC_DISTANCE_MEDIUM   BF20_MIC_DISTANCE_P4

Medium distance (~100 cm)

◆ BF20_MIC_DISTANCE_P1

#define BF20_MIC_DISTANCE_P1   0x0D

Microphone preamplifier level +1

◆ BF20_MIC_DISTANCE_P2

#define BF20_MIC_DISTANCE_P2   0x0E

Microphone preamplifier level +2

◆ BF20_MIC_DISTANCE_P3

#define BF20_MIC_DISTANCE_P3   0x0F

Microphone preamplifier level +3

◆ BF20_MIC_DISTANCE_P4

#define BF20_MIC_DISTANCE_P4   0x10

Microphone preamplifier level +4

◆ BF20_MIC_DISTANCE_P5

#define BF20_MIC_DISTANCE_P5   0x11

Microphone preamplifier level +5

◆ BF20_MIC_DISTANCE_P6

#define BF20_MIC_DISTANCE_P6   0x12

Microphone preamplifier level +6

◆ BF20_MIC_DISTANCE_P7

#define BF20_MIC_DISTANCE_P7   0x13

Microphone preamplifier level +7

◆ BF20_MIC_DISTANCE_P8

#define BF20_MIC_DISTANCE_P8   0x14

Microphone preamplifier level +8 (maximum)

◆ BF20_MIC_DISTANCE_SHORT

#define BF20_MIC_DISTANCE_SHORT   BF20_MIC_DISTANCE_P2

Short distance (~30 cm)

◆ BF20_MIC_DISTANCE_VERY_SHORT

#define BF20_MIC_DISTANCE_VERY_SHORT   BF20_MIC_DISTANCE_0

Very short distance (~10 cm)

◆ BF20_MIC_LEVEL_0

#define BF20_MIC_LEVEL_0   0x13

Microphone attenuation level 0

◆ BF20_MIC_LEVEL_M1

#define BF20_MIC_LEVEL_M1   0x14

Microphone attenuation level -1

◆ BF20_MIC_LEVEL_M10

#define BF20_MIC_LEVEL_M10   0x1D

Microphone attenuation level -10

◆ BF20_MIC_LEVEL_M11

#define BF20_MIC_LEVEL_M11   0x1E

Microphone attenuation level -11 (minimum)

◆ BF20_MIC_LEVEL_M2

#define BF20_MIC_LEVEL_M2   0x15

Microphone attenuation level -2

◆ BF20_MIC_LEVEL_M3

#define BF20_MIC_LEVEL_M3   0x16

Microphone attenuation level -3

◆ BF20_MIC_LEVEL_M4

#define BF20_MIC_LEVEL_M4   0x17

Microphone attenuation level -4

◆ BF20_MIC_LEVEL_M5

#define BF20_MIC_LEVEL_M5   0x18

Microphone attenuation level -5

◆ BF20_MIC_LEVEL_M6

#define BF20_MIC_LEVEL_M6   0x19

Microphone attenuation level -6

◆ BF20_MIC_LEVEL_M7

#define BF20_MIC_LEVEL_M7   0x1A

Microphone attenuation level -7

◆ BF20_MIC_LEVEL_M8

#define BF20_MIC_LEVEL_M8   0x1B

Microphone attenuation level -8

◆ BF20_MIC_LEVEL_M9

#define BF20_MIC_LEVEL_M9   0x1C

Microphone attenuation level -9

◆ BF20_MIC_LEVEL_P1

#define BF20_MIC_LEVEL_P1   0x12

Microphone attenuation level +1

◆ BF20_MIC_LEVEL_P2

#define BF20_MIC_LEVEL_P2   0x11

Microphone attenuation level +2

◆ BF20_MIC_LEVEL_P3

#define BF20_MIC_LEVEL_P3   0x10

Microphone attenuation level +3 (maximum)

◆ BF20_MIC_MUTE

#define BF20_MIC_MUTE   0x01

Microphone is muted.

◆ BF20_MIC_OFF_LINE_IN

#define BF20_MIC_OFF_LINE_IN   0x04

Signal from microphone not added to analogue line in.

◆ BF20_MIC_ON_LINE_IN

#define BF20_MIC_ON_LINE_IN   0x0C

Signal from microphone added to analogue line in.

◆ BF20_MIC_THRESHOLD_HIGH

#define BF20_MIC_THRESHOLD_HIGH   0x10

Microphone noise compression high

◆ BF20_MIC_THRESHOLD_LOW

#define BF20_MIC_THRESHOLD_LOW   0x12

Microphone noise compression low

◆ BF20_MIC_THRESHOLD_LOWER

#define BF20_MIC_THRESHOLD_LOWER   0x13

Microphone noise compression lower

◆ BF20_MIC_THRESHOLD_MID

#define BF20_MIC_THRESHOLD_MID   0x11

Microphone noise compression medium

◆ BF20_MIC_THRESHOLD_VERY_LOW

#define BF20_MIC_THRESHOLD_VERY_LOW   0x14

Microphone noise compression very low

◆ BF20_MICAMP_MODE_LIN

#define BF20_MICAMP_MODE_LIN   0x37

Microphone amplifier mode - Linear

◆ BF20_MICAMP_MODE_LOG

#define BF20_MICAMP_MODE_LOG   0x33

Microphone amplifier mode - Logaritmic. When the microphone amplifier is set to logaritmic mode, you can set additional settings: optimal distance, noise threshold and compression.

◆ BF20_PCM_SCENARIO_AB

#define BF20_PCM_SCENARIO_AB   0x3C

PMC scenario - Both channels of codec A to left speaker and both channels of codec B to right speaker.

◆ BF20_PCM_SCENARIO_LR

#define BF20_PCM_SCENARIO_LR   0x3D

PMC scenario - Left channels of codec A and B to left speaker and right channels of codec A and B to right speaker.

◆ BF20_PTT_LED_BLINK

#define BF20_PTT_LED_BLINK   0x20

PTT LED blinks.

◆ BF20_PTT_LED_OFF

#define BF20_PTT_LED_OFF   0x00

PTT LED is off.

◆ BF20_PTT_LED_ON

#define BF20_PTT_LED_ON   0x10

PTT LED lights.

◆ BF20_SPK_LEVEL_MAX

#define BF20_SPK_LEVEL_MAX   0x14

Speaker level 20 - maximum

◆ BF20_SPK_LEVEL_MIN

#define BF20_SPK_LEVEL_MIN   0x00

Speaker level 0 - minimum

◆ BF20_VU_AB_MIC_OFF

#define BF20_VU_AB_MIC_OFF   0x33

Microphone signal is not shown.

◆ BF20_VU_AB_MIC_ON

#define BF20_VU_AB_MIC_ON   0x37

Microphone signal is shown on VU meter.

Function Documentation

◆ TiproBF20GetEchoMode()

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

Returns the echo canceler mode (OFF/L/R/LR)

Parameters
[in]deviceDevice
[out]nModeEcho canceler mode (OFF/L/R/LR)
[out]nInitModeInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetLeftSpeakerLevel()

int TiproBF20GetLeftSpeakerLevel ( TiproHidDevice *  device,
int *  nLevel 
)

Returns the level of the left speaker.

Parameters
[in]deviceDevice
[out]nLevelSpeaker level
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetLFSpeakerState()

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

Get LF speaker state.

Parameters
[in]deviceDevice
[out]nStateLF speaker state (on/off)
[out]nInitStateInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetLineOut2SpkMode()

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

Returns the connection mode (OFF/L/R/LR) of the motherboard LINE-OUT port to the speakers.

Parameters
[in]deviceDevice
[out]nModeConnection mode (OFF/L/R/LR)
[out]nInitModeInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetLuminance()

int TiproBF20GetLuminance ( TiproHidDevice *  device,
int *  nLuminance 
)

Returns luminance for both stripe and LCD backlight.

Parameters
[in]deviceDevice
[out]nLuminanceLuminance index (0-darkest; 20-brightest)
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMic2LineInState()

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

Returns the connection state (ON/OFF) of the gooseneck microphone to the LINE-IN port on the motherboard.

Parameters
[in]deviceDevice
[out]nStateConnection state (ON/OFF)
[out]nInitStateInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMicAmpMode()

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

Get Microphone amplifier mode (Linear/Logarithmic)

Parameters
[in]deviceDevice
[out]nMicAmpModeMicrophone amplifier mode (LIN/LOG)
[out]nInitMicAmpModeInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMicOnVUState()

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

Get microphone signal shown on VU-meter state.

Parameters
[in]deviceDevice
[out]nStateMicrophone signal on VU-meter state (on/off)
[out]nInitStateInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMicrophoneCompression()

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

Returns compression for the microphone signal.

Parameters
[in]deviceDevice
[out]nCompressionMicrophone compression
[out]nInitCompressionInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMicrophoneLevel()

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

Returns the googeneck microphone level.

Parameters
[in]deviceDevice
[out]nLevelMicrophone level
[out]nInitLevelInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMicrophoneOptimalDistance()

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

Gets the microphone optimal distance.

Parameters
[in]deviceDevice
[out]nDistanceMicrophone optimal distance
[out]nInitDistanceInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetMicrophoneThreshold()

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

Returns threshold for the microphone signal.

Parameters
[in]deviceDevice
[out]nThresholdMicrophone threshold
[out]nInitThresholdInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetPCMScenario()

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

Get PCM scenario.

Parameters
[in]deviceDevice
[out]nScenarioPCM scenario (AB2LR / LR2LR)
[out]nInitScenarioInitial state from EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetPTTKeyLEDState()

int TiproBF20GetPTTKeyLEDState ( TiproHidDevice *  device,
int *  nState 
)

Returns the LED state of the illuminated PTT Key.

Parameters
[in]deviceDevice
[out]nStateState of the LED (LED_ON/LED_OFF/LED_BLINK)
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetPTTKeyState()

int TiproBF20GetPTTKeyState ( TiproHidDevice *  device,
int *  nState 
)

Returns the state of the PTT key.

Parameters
[in]deviceDevice
[out]nStateState of the key (KEY_PRESSED / KEY_RELEASED)
Returns
Command status: 0-OK, else error code

◆ TiproBF20GetRightSpeakerLevel()

int TiproBF20GetRightSpeakerLevel ( TiproHidDevice *  device,
int *  nLevel 
)

Returns the level of the right speaker.

Parameters
[in]deviceDevice
[out]nLevelSpeaker level
Returns
Command status: 0-OK, else error code

◆ TiproBF20MuteMicrophone()

int TiproBF20MuteMicrophone ( TiproHidDevice *  device,
int  nMute 
)

Mutes/un-mutes the microphone signal.

Parameters
[in]deviceDevice
[in]nMuteMute/un-mute microphone
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetEchoMode()

int TiproBF20SetEchoMode ( TiproHidDevice *  device,
int  nMode 
)

Sets the echo canceler mode (OFF/L/R/LR)

Parameters
[in]deviceDevice
[in]nModeEcho canceler mode (OFF/L/R/LR)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetLeftSpeakerLevel()

int TiproBF20SetLeftSpeakerLevel ( TiproHidDevice *  device,
int  nLevel 
)

Sets the level of the left speaker.

Parameters
[in]deviceDevice
[in]nLevelSpeaker level
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetLFSpeakerState()

int TiproBF20SetLFSpeakerState ( TiproHidDevice *  device,
int  nState 
)

Set LF speaker state (ON/OFF)

Parameters
[in]deviceDevice
[in]nStateLF speaker state (on/off)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetLineOut2SpkMode()

int TiproBF20SetLineOut2SpkMode ( TiproHidDevice *  device,
int  nMode 
)

Sets the connection mode (OFF/L/R/LR) of the motherboard LINE-OUT port to the speakers.

Parameters
[in]deviceDevice
[in]nModeConnection mode (OFF/L/R/LR)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetLuminance()

int TiproBF20SetLuminance ( TiproHidDevice *  device,
int  nLuminance 
)

Sets luminance for both stripe and LCD backlight.

Parameters
[in]deviceDevice
[in]nLuminanceLuminance index (0-darkest; 20-brightest)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMic2LineInState()

int TiproBF20SetMic2LineInState ( TiproHidDevice *  device,
int  nState 
)

Sets the connection state (ON/OFF) of the gooseneck microphone to the LINE-IN port on the motherboard.

Parameters
[in]deviceDevice
[in]nStateConnection state (ON/OFF)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMicAmpMode()

int TiproBF20SetMicAmpMode ( TiproHidDevice *  device,
int  nMicAmpMode 
)

Set Microphone amplifier mode (Linear/Logarithmic)

Parameters
[in]deviceDevice
[in]nMicAmpModeicrophone amplifier mode (LIN/LOG)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMicOnVUState()

int TiproBF20SetMicOnVUState ( TiproHidDevice *  device,
int  nState 
)

Sets if microphone signal is shown on the VU-meter (ON/OFF)

Parameters
[in]deviceDevice
[in]nStateMicrophone on VU-meter state (on/off)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMicrophoneCompression()

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

Sets compression for the microphone signal.

Parameters
[in]deviceDevice
[in]nCompressionMicrophone compression
[in]bSetInitWrite initial state to EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMicrophoneLevel()

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

Sets the gooseneck microphone level.

Parameters
[in]deviceDevice
[in]nLevelMicrophone level
[in]bSetInitWrite initial state to EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMicrophoneOptimalDistance()

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

Sets the microphone optimal distance.

Parameters
[in]deviceDevice
[in]nDistanceMicrophone optimal distance
[in]bSetInitWrite initial state to EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetMicrophoneThreshold()

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

Sets threshold for the microphone signal.

Parameters
[in]deviceDevice
[in]nThresholdMicrophone threshold
[in]bSetInitWrite initial state to EEPROM
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetPCMScenario()

int TiproBF20SetPCMScenario ( TiproHidDevice *  device,
int  nScenario 
)

Set PCM scenario.

Parameters
[in]deviceDevice
[in]nScenarioPCM scenario (AB2LR / LR2LR)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetPTTKeyLEDState()

int TiproBF20SetPTTKeyLEDState ( TiproHidDevice *  device,
int  nState 
)

Sets the LED state of illuminated PTT key.

Parameters
[in]deviceDevice
[in]nStatePTT LED state (PTT_LED_ON/PTT_LED_OFF/PTT_LED_BLINK)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetPTTKeyLEDStateEx()

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

Sets the operation of the illuminated PTT key with more paramters.

Parameters
[in]deviceDevice
[in]nStatePTT LED state (PTT_LED_ON/PTT_LED_OFF/PTT_LED_BLINK)
[in]nTBlinkOnOn period for blink mode (ms)
[in]nTBlinkOffOff period for blink mode (ms)
Returns
Command status: 0-OK, else error code

◆ TiproBF20SetRightSpeakerLevel()

int TiproBF20SetRightSpeakerLevel ( TiproHidDevice *  device,
int  nLevel 
)

Sets the level of the right speaker.

Parameters
[in]deviceDevice
[in]nLevelSpeaker level
Returns
Command status: 0-OK, else error code

◆ TiproBF20TouchscreenDisable()

int TiproBF20TouchscreenDisable ( TiproHidDevice *  device)

Disables touchscreen.

Parameters
[in]deviceDevice
Returns
Command status: 0-OK, else error code

◆ TiproBF20TouchscreenEnable()

int TiproBF20TouchscreenEnable ( TiproHidDevice *  device)

Enables touchscreen.

Parameters
[in]deviceDevice
Returns
Command status: 0-OK, else error code
Generated by   doxygen 1.8.13