From 6bdf30bd1aef80ca8cf68d13a2e7007d40a5f6b8 Mon Sep 17 00:00:00 2001 From: DMchen Date: Mon, 20 Nov 2023 17:24:07 +0800 Subject: [PATCH] 1.SDK_DLL部分[内部] 启动业务增加样例。 2.SDK应用部分[内部] 开始签到部分参数位置调整。 --- img/image7.png | Bin 0 -> 7590 bytes 通讯协议-SDK_DLL部分[内部].md | 842 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-------------------------------------------------------------------------------------------------------------------- 通讯协议-SDK应用部分[内部].md | 9 ++++----- 3 files changed, 730 insertions(+), 121 deletions(-) create mode 100644 img/image7.png diff --git a/img/image7.png b/img/image7.png new file mode 100644 index 0000000..c35b948 Binary files /dev/null and b/img/image7.png differ diff --git a/通讯协议-SDK_DLL部分[内部].md b/通讯协议-SDK_DLL部分[内部].md index 127546e..e63182d 100644 --- a/通讯协议-SDK_DLL部分[内部].md +++ b/通讯协议-SDK_DLL部分[内部].md @@ -302,29 +302,29 @@ HDParamCallBack 回调接口反馈数据解析: | **参数名称** | **参数说明** | **范围** | **备注** | | --- | --- | --- | --- | -|int Moed1|签到模式| 1:指定键签到
2:PIN码签到(默认值)|| -|int Moed2|修改模式|0:不可修改
1:可以修改(默认值)|| -|int Moed3|迫选模式|0:(默认值)|| -|int Moed4|选项数目|10:(默认值)|| -|int Moed5|可选项数|1≤N≤14 (指定位数才需要设置)|| +|int bindMode|签到模式| 1:指定键签到
2:PIN码签到(默认值)|| +|int modifyMode|修改模式|0:不可修改
1:可以修改(默认值)|| +|int lessMode|迫选模式|0:(默认值)|| +|int options|选项数目|10:(默认值)|| +|int optionalN|可选位数|1≤N≤14 || |int KeyValue|指定按键键值|0:未指定[OK键签到]
1:1
2:2
3:3
4:4
5:5
6:6
7:7
8:8
9:9
10:0
11:上键
12:下键
13:OK
14:ESC
15: Menu || 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_Sign_in_Event( - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0, - int Moed4 = 0, - int Moed5 = 0, - int KeyValue=0); //开始签到功能 -``` -#### 启动样例: -目的:PIN签到模式,可以修改,可选项数6 + int bindMode, + int modifyMode, + int lessMode, + int options, + int optionalN, + int KeyValue); //开始签到功能 +``` +#### 样例: +样例目的:PIN签到模式,可以修改,可选位数4位 ##### 启动功能部分: ```C++ Set_Custom_Title(0, 3, "TXT"); //设置自定义标题 -Start_Sign_in_Event(2, 0, 0, 0, 6, 0); //开启pin模式签到 +Start_Sign_in_Event(2, 0, 0, 0, 4, 0); //开启pin模式签到 ``` HDParamCallBack 回调接口反馈数据解析: @@ -368,11 +368,11 @@ HDParamCallBack 回调接口反馈数据解析: | --- | --- | --- | --- | |UCHAR iBaseID|基站ID|0~32|| |ULONG KeySN|指定键盘SN||| -|int Moed1|签到模式| 1:指定键签到
2:PIN码签到(默认值)|| -|int Moed2|修改模式|0:不可修改
1:可以修改(默认值)|| -|int Moed3|迫选模式|0:(默认值)|| -|int Moed4|选项数目|10:(默认值)|| -|int Moed5|可选项数|1≤N≤14 (指定位数才需要设置)|| +|int bindMode|签到模式| 1:指定键签到
2:PIN码签到(默认值)|| +|int modifyMode|修改模式|0:不可修改
1:可以修改(默认值)|| +|int lessMode|迫选模式|0:(默认值)|| +|int options|选项数目|10:(默认值)|| +|int optionalN|可选位数|1≤N≤14 || |int KeyValue|指定按键键值|0:未指定[OK键签到]
1:1
2:2
3:3
4:4
5:5
6:6
7:7
8:8
9:9
10:0
11:上键
12:下键
13:OK
14:ESC
15: Menu || |UCHAR Txt_Len|提示标题长度|1~16字节|| |const char* Txt|提示标题|字符串|| @@ -382,22 +382,22 @@ HDParamCallBack 回调接口反馈数据解析: extern"C" __declspec(dllexport) bool Start_Sign_in_Event_SN( UCHAR iBaseID, ULONG KeySN, - int Moed1, - int Moed2, - int Moed3, - int Moed4, - int Moed5, + int bindMode, + int modifyMode, + int lessMode, + int options, + int optionalN, int KeyValue, UCHAR Txt_Len, const char* Txt); //开始签到功能 ``` -#### 启动样例: -目的:PIN签到模式,可以修改,可选项数6 +#### 样例: +样例目的:PIN签到模式,可以修改,可选项数6 ##### 启动功能部分: ```C++ //指定键盘开启pin模式签到,带自定义标题 -Start_Sign_in_Event_SN(0,1837454011,2, 0, 0, 0, 6, 0, 3, "TXT"); +Start_Sign_in_Event_SN(0,1837454011,2, 0, 0, 0, 4, 0, 3, "TXT"); ``` HDParamCallBack 回调接口反馈数据解析: @@ -416,14 +416,14 @@ KeyEventCallBack 回调接口反馈数据解析: |UCHAR iBaseID|基站ID|1|| |unsigned long long keySn|键盘SN|1837454011|| |float Time|反馈时间[秒]|0.5|| -|int mode|回调反馈数据模式|1|| +|int mode|回调反馈数据模式|4|| |int RxMode|预留|0|| |const char* sInfo|回调反馈数据|"0,1001,0,0"|"预留,按键值,预留,预留"| ##### 退出功能部分: ```C++ -ExitEvent(1); //带签到模式切换到空闲模式 +ExitEvent(1); // ``` HDParamCallBack 回调接口反馈数据解析: @@ -431,19 +431,19 @@ HDParamCallBack 回调接口反馈数据解析: | --- | --- | --- | --- | |int iBaseID|基站ID|1|| |int mode|模式|0|| -|const char* sInfo|参数字符串|"1,OK"|1:签到绑定带参数切换空闲模式成功| - +|const char* sInfo|参数字符串|"41,OK"|1:签到模式切换空闲模式成功| -## 数字题功能[广播] +## 数字题 +### 数字题功能[广播] 函数名称:Start_Number_Event 功能:数字题功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为数字功能模式 | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| -|secrecyMode|保密模式|0:不保密(默认值)
1:保密|| -|modifyMode|修改模式|0:不可修改
1:可以修改(默认值)| |aswOption|按键模式|0:无规则 (S6最多16位,T2最多14位)
1:预留
2:预留
3:带小数位上下限(T2不支持)| +|modifyMode|修改模式|0:不可修改
1:可以修改(默认值)| +|secrecyMode|保密模式|0:不保密(默认值)
1:保密|| |digits|小数位数|0:没有小数点
1:一位小数点
2:二位小数点| |numMin|下限|aswOption=3
digits=0 范围:0~65535
digits=1 范围:0~6553
digits=2 范围:0~655| |numMax|上限|aswOption=3
digits=0 范围:0~65535
digits=1 范围:0~6553
digits=2 范围:0~655| @@ -451,15 +451,56 @@ HDParamCallBack 回调接口反馈数据解析: 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_Number_Event( - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0, - int digits = 0, - USHORT numMax = 0, - USHORT numMin = 0); // + int aswOption, + int modifyMode, + int secrecyMode, + int digits, + USHORT numMax, + USHORT numMin); // ``` -## 数字题功能[指定键盘SN] +#### 样例: +样例目的:启动数字题,可以修改结果,两位小数,上限:655,下限:0 +##### 启动功能部分: +```C++ +Set_Custom_Title(0, 3, "TXT"); //设置自定义标题 +Start_Number_Event(0, 0, 0, 2, 655, 0); //开启启动数字题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|916|数字题模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|4|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,99.99,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(4); //带数字题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"4,OK"|4:带数字题模式切换到空闲模式成功| + + +### 数字题功能[指定键盘SN] 函数名称:Start_Number_Event_SN 功能:数字题功能[指定键盘SN] 说明:把SDK管理的指定在线键盘设置为数字题功能模式 @@ -492,7 +533,47 @@ extern"C" __declspec(dllexport) bool Start_Number_Event_SN( const char* Txt); // ``` -## 判断题功能[广播] +#### 样例: +样例目的:启动数字题,可以修改结果,两位小数,上限:655,下限:0 +##### 启动功能部分: +```C++ +Start_Number_Event_SN(0,1837454011,0, 0, 0, 2, 655, 0, 3, "TXT"); //开启启动数字题 +``` +VoteEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|301:S6
302:T2|| +|const char* sInfo|参数字符串|S6:"投票模式,键盘SN,结果,预留,预留"
T2:"投票模式,键盘SN,结果"|| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|1|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,99.99,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(4); //带数字题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"4,OK"|4:带数字题模式切换到空闲模式成功| + +## 判断题 +### 判断题功能[广播] 函数名称:Start_TrueFalse_Event 功能:判断题功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为判断题功能模式 @@ -500,8 +581,9 @@ extern"C" __declspec(dllexport) bool Start_Number_Event_SN( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| | optionsMode | 选项类别 | 1:True/False 对/错
2:Yes/No 是/否
3:√/×| -| secrecyMode | 保密模式 | 0:不保密(默认值)
1:保密| | modifyMode | 修改模式 | 0:不可修改
1:可以修改(默认值)| +| secrecyMode | 保密模式 | 0:不保密(默认值)
1:保密| + 接口代码: @@ -512,7 +594,48 @@ extern"C" __declspec(dllexport) bool Start_TrueFalse_Event( int Moed3 = 0); ``` -## 判断题功能[指定键盘SN] +#### 样例: +样例目的:启动判断题,可以修改结果 +##### 启动功能部分: +```C++ +Set_Custom_Title(0, 3, "TXT"); //设置自定义标题 +Start_TrueFalse_Event(1, 1, 0); //开启启动判断题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|912|判断题模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|5|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,1,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(5); //带判断题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"5,OK"|5:带判断题模式切换到空闲模式成功| + + +### 判断题功能[指定键盘SN] 函数名称:Start_TrueFalse_Event_SN 功能:判断题功能[指定键盘SN] 说明:把SDK管理的指定在线键盘设置为判断题功能模式 @@ -522,24 +645,65 @@ extern"C" __declspec(dllexport) bool Start_TrueFalse_Event( |UCHAR iBaseID|基站ID|0~32|| |ULONG KeySN|指定键盘SN||| | optionsMode | 选项类别 | 1:True/False 对/错
2:Yes/No 是/否
3:√/×| -| secrecyMode | 保密模式 | 0:不保密(默认值)
1:保密| | modifyMode | 修改模式 | 0:不可修改
1:可以修改(默认值)| +| secrecyMode | 保密模式 | 0:不保密(默认值)
1:保密| |UCHAR Txt_Len|提示标题长度|1~16字节|| |Txt|提示标题|字符串,长度最多不超过16个字节| 接口代码: ```C++ -extern"C" __declspec(dllexport) bool T2_Start_TrueFalse_Event( +extern"C" __declspec(dllexport) bool Start_TrueFalse_Event_SN( UCHAR iBaseID, ULONG KeySN, - int Moed1, - int Moed2, - int Moed3, + int optionsMode, + int modifyMode, + int secrecyMode, UCHAR Txt_Len, const char* Txt); // ``` -## 选择题功能[广播] +#### 样例: +样例目的:启动判断题,可以修改结果 +##### 启动功能部分: +```C++ +Start_TrueFalse_Event_SN(0,1837454011,1, 1, 0, 3, "TXT"); //开启启动判断题 +``` +VoteEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|301:S6
302:T2|| +|const char* sInfo|参数字符串|S6:"投票模式,键盘SN,结果,预留,预留"
T2:"投票模式,键盘SN,结果"|| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|5|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,1,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(5); //带判断题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"5,OK"|5:带判断题模式切换到空闲模式成功| + + +## 选择题 +### 选择题功能[广播] 函数名称:Start_TrueFalse_Event 功能:选择题功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为选择题功能模式 @@ -547,8 +711,8 @@ extern"C" __declspec(dllexport) bool T2_Start_TrueFalse_Event( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| |optionsMode|选项类别|1:显示字母(默认值)
2:显示数字 | -|secrecyMode|保密模式|0:不保密(默认值)
1:保密 | |modifyMode|修改模式|0:不可修改
1:可以修改(默认值) | +|secrecyMode|保密模式|0:不保密(默认值)
1:保密 | |lessMode|迫选模式| 0:可缺选(默认值)
1:不可缺选
2:允许重复输入
3:允许重复输入且不可缺选 | | options|选项数目|1≤M≤10(默认值4)| | optionalN|可选项数|1≤N≤M(默认值1)| @@ -557,15 +721,55 @@ extern"C" __declspec(dllexport) bool T2_Start_TrueFalse_Event( 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_Choice_Event( - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0, - int Moed4 = 0, - int Moed5 = 0, - int Moed6 = 0); + int optionsMode, + int modifyMode, + int secrecyMode, + int lessMode, + int options, + int optionalN); ``` -## 选择题功能[指定键盘SN] +#### 样例: +样例目的:启动选择题,字母类型,4选1,可以修改结果 +##### 启动功能部分: +```C++ +Set_Custom_Title(0, 3, "TXT"); //设置自定义标题 +Start_Choice_Event(1, 1, 0,0, 4, 1); //开启启动选择题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|910|选择题模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|10|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,A,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(10); //带判断题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"5,OK"|5:带判断题模式切换到空闲模式成功| + +### 选择题功能[指定键盘SN] 函数名称:Start_Choice_Event_SN 功能:选择题功能[指定键盘SN] 说明:把SDK管理的指定在线键盘设置为选择题功能模式 @@ -588,17 +792,58 @@ extern"C" __declspec(dllexport) bool Start_Choice_Event( extern"C" __declspec(dllexport) bool Start_Choice_Event_SN( UCHAR iBaseID, ULONG KeySN, - int Moed1, - int Moed2, - int Moed3, - int Moed4, - int Moed5, - int Moed6, + int optionsMode, + int modifyMode, + int secrecyMode, + int lessMode, + int options, + int optionalN, UCHAR Txt_Len, const char* Txt); ``` -## 语音题功能[广播] +#### 样例: +样例目的:启动选择题,字母类型,4选1,可以修改结果 +##### 启动功能部分: +```C++ +Start_Choice_Event_SN(0,1837454011, 1, 1, 0,0, 4, 1, 3, "TXT"); //开启启动判断题 +``` +VoteEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|301:S6
302:T2|| +|const char* sInfo|参数字符串|S6:"投票模式,键盘SN,结果,预留,预留"
T2:"投票模式,键盘SN,结果"|| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|10|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,A,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(10); //带选择题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"10,OK"|10:带选择题模式切换到空闲模式成功| + + +## 语音题 +### 语音题功能[广播] 函数名称:Start_Voice_Event 功能:语音题功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为语音题功能模式 @@ -622,7 +867,52 @@ extern"C" __declspec(dllexport) bool Start_Voice_Event( int OutMode); ``` -## 语音题功能[指定键盘SN] +#### 样例: +样例目的:启动语音题,mp3格式 +##### 启动功能部分: +```C++ +Set_Custom_Title(0, 3, "TXT"); //设置自定义标题 +Start_Voice_Event(0, 0, 0,0); //开启启动语音题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|922|语音题模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +VoiceStreamEventCallBackFunc 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long keySn|键盘SN|1837454011|| +|int Mode|反馈数据模式|0:mp3(默认值)
1:实时流|| +|USHORT voiceId|回话ID|答题时间内,可重复提交语音,每段语音流加一个回话ID,用于区分作答|| +|USHORT dataIndex|数据包号|1开始|| +|const char* data|回调反馈数据|Mode=0:反馈的是MP3文件路径
Mode=1:反馈的是实时数据流|| +|int len|数据长度|Base64编码后的字符串长度。应该将 "data" 通过Base64解码后得到原始的数据长度。|| +|int sampleRate|音频采样率|16000|| +|int bitsPerSample|音频采样精度|16|| +|int channel|声道数|1|单声道| +|int recFlag|结束标志|默认为0,为1表示结束|| + +##### 退出功能部分: +```C++ +ExitEvent(16); //带语音题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"16,OK"|16:带语音题模式切换到空闲模式成功| + +### 语音题功能[指定键盘SN] 函数名称:Start_Voice_Event_SN 功能:语音题功能[指定键盘SN] 说明:把SDK管理的指定在线键盘设置为语音题功能模式 @@ -653,7 +943,52 @@ extern"C" __declspec(dllexport) bool Start_Voice_Event_SN( const char* Txt);// ``` -## 自由题功能 +#### 样例: +样例目的:启动语音题,mp3格式 +##### 启动功能部分: +```C++ +Start_Voice_Event_SN(0,1837454011, 0, 0, 0,0, 3, "TXT"); //开启启动语音题 +``` +VoteEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|301:S6
302:T2|| +|const char* sInfo|参数字符串|S6:"投票模式,键盘SN,结果,预留,预留"
T2:"投票模式,键盘SN,结果"|| + +##### 接收按键数据部分: + +VoiceStreamEventCallBackFunc 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long keySn|键盘SN|1837454011|| +|int Mode|反馈数据模式|0:mp3(默认值)
1:实时流|| +|USHORT voiceId|回话ID|答题时间内,可重复提交语音,每段语音流加一个回话ID,用于区分作答|| +|USHORT dataIndex|数据包号|1开始|| +|const char* data|回调反馈数据|Mode=0:反馈的是MP3文件路径
Mode=1:反馈的是实时数据流|| +|int len|数据长度|Base64编码后的字符串长度。应该将 "data" 通过Base64解码后得到原始的数据长度。|| +|int sampleRate|音频采样率|16000|| +|int bitsPerSample|音频采样精度|16|| +|int channel|声道数|1|单声道| +|int recFlag|结束标志|默认为0,为1表示结束|| + +##### 退出功能部分: +```C++ +ExitEvent(16); //带语音题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"16,OK"|16:带语音题模式切换到空闲模式成功| + +## 自由题 +### 自由题功能 函数名称:Start_Free_Question_Event 功能:自由题功能 说明:把SDK管理的所有基站的在线键盘设置为自由题功能模式 @@ -661,7 +996,7 @@ extern"C" __declspec(dllexport) bool Start_Voice_Event_SN( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| |UCHAR iBaseID|基站ID|0~32|| -|ULONG KeySN|指定键盘SN||| +|ULONG KeySN|指定键盘SN|0:默认值|| 接口代码: @@ -670,8 +1005,47 @@ extern"C" __declspec(dllexport) bool Start_Free_Question_Event( UCHAR iBaseID, ULONG KeySN); ``` +#### 样例: +样例目的:启动自由题 +##### 启动功能部分: +```C++ +Start_Free_Question_Event(0,0); //开启启动自由题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|943|自由题模式| +|const char* sInfo|参数字符串|"OK"|成功| -## 抢答题功能 +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|10|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,A,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(10); //带自由题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"10,OK"|10:带自由题模式切换到空闲模式成功| + +## 抢答题 +### 抢答题功能 函数名称:Start_Rush_Answer_Event 功能:抢答题功能 @@ -679,20 +1053,58 @@ extern"C" __declspec(dllexport) bool Start_Free_Question_Event( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| -|rushAnswerMode| 抢答模式|0:普通抢答(默认值)| -|Moed2| 预留|0:(默认值)| -|modifyMode|修改模式|0:不可修改
1:可以修改(默认值)| +|int rushAnswerMode| 抢答模式|0:普通抢答(默认值)| +|int Moed2| 预留|0:(默认值)| +|int modifyMode|修改模式|0:不可修改
1:可以修改(默认值)| 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_Rush_Answer_Event( - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0); //抢答 + int intrushAnswerMode, + int Moed2, + int modifyMode); //抢答 +``` +#### 样例: +样例目的:启动抢答题 +##### 启动功能部分: +```C++ +Start_Rush_Answer_Event(0, 0, 0); //开启抢答题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|914|抢答题模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|13|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,1,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(13); //带选择题模式切换到空闲模式 ``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"13,OK"|13:带抢答题模式切换到空闲模式成功| -## 抢答题功能[指定键盘SN] +### 抢答题功能[指定键盘SN] 函数名称:Start_Rush_Answer_Event_SN 功能:抢答题功能[指定键盘SN] 说明:把SDK管理的指定在线键盘设置为抢答题功能模式 @@ -701,23 +1113,62 @@ extern"C" __declspec(dllexport) bool Start_Rush_Answer_Event( | --- | --- | --- | --- | |UCHAR iBaseID|基站ID|0~32|| |ULONG KeySN|指定键盘SN||| -|rushAnswerMode| 抢答模式|0:普通抢答(默认值)| -|Moed2| 预留|0:(默认值)| -|modifyMode|修改模式|0:不可修改
1:可以修改(默认值)| -|UCHAR Txt_Len|提示标题长度|1~16字节|| -|Txt|提示标题|字符串,长度最多不超过16个字节| +|int rushAnswerMode| 抢答模式|0:普通抢答(默认值)| +|int Moed2| 预留|0:(默认值)| +|int modifyMode|修改模式|0:不可修改
1:可以修改(默认值)| + 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_Rush_Answer_Event_SN( UCHAR iBaseID, ULONG KeySN, - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0); //抢答模式 + int rushAnswerMode, + int Moed2, + int modifyMode); //抢答模式 ``` -## 填空题功能 +#### 样例: +样例目的:启动抢答题 +##### 启动功能部分: +```C++ +Start_Rush_Answer_Event_SN(0,1837454011, 0, 0, 0); //开启抢答题 +``` +VoteEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|301:S6
302:T2|| +|const char* sInfo|参数字符串|S6:"投票模式,键盘SN,结果,预留,预留"
T2:"投票模式,键盘SN,结果"|| + +##### 接收按键数据部分: + +keyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|13|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,1,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(13); //带抢答题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"13,OK"|13:带抢答题模式切换到空闲模式成功| + +## 填空题 +### 填空题功能 函数名称:Start_Rush_Answer_Event 功能:填空题功能 @@ -725,21 +1176,61 @@ extern"C" __declspec(dllexport) bool Start_Rush_Answer_Event_SN( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| -| optionsMode | 填空类型 | 1:任意输入(默认值) | -| modifyMode | 预留 | 1: (默认值) | -| secrecyMode | 预留 | 0: (默认值) | +| int optionsMode | 填空类型 | 1:任意输入(默认值) | +| int modifyMode | 修改模式|0:不可修改
1:可以修改(默认值)| +| int secrecyMode | 预留 | 0: (默认值) | 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_TextAnswer_Event( - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0); + int optionsMode, + int modifyMode, + int secrecyMode); ``` -## 填空题功能[指定键盘SN] -函数名称:Start_Rush_Answer_Event_SN +#### 样例: +样例目的:启动抢答题 +##### 启动功能部分: +```C++ +Start_TextAnswer_Event(1, 1, 0); //开启填空题 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|924|抢答题模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|12|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"填空内容"|| + +##### 退出功能部分: +```C++ +ExitEvent(12); //带填空题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"12,OK"|12:带填空题模式切换到空闲模式成功| + + +### 填空题功能[指定键盘SN] +函数名称:Start_TextAnswer_Event_SN 功能:填空题功能[指定键盘SN] 说明:把SDK管理的指定在线键盘设置为填空题功能模式 @@ -747,21 +1238,61 @@ extern"C" __declspec(dllexport) bool Start_TextAnswer_Event( | --- | --- | --- | --- | |UCHAR iBaseID|基站ID|0~32|| |ULONG KeySN|指定键盘SN||| -| optionsMode | 填空类型 | 1:任意输入(默认值) | -| modifyMode | 预留 | 1: (默认值) | -| secrecyMode | 预留 | 0: (默认值) | +| int optionsMode | 填空类型 | 1:任意输入(默认值) | +| int modifyMode | 修改模式|0:不可修改
1:可以修改(默认值)| +| int secrecyMode | 预留 | 0: (默认值) | 接口代码: ```C++ extern"C" __declspec(dllexport) bool Start_TextAnswer_Event_SN( UCHAR iBaseID, ULONG KeySN, - int Moed1 = 1, - int Moed2 = 0, - int Moed3 = 0); //抢答模式 + int optionsMode, + int modifyMode, + int secrecyMode); //填空模式 ``` -## 模拟测试功能[广播] +#### 样例: +样例目的:启动填空题 +##### 启动功能部分: +```C++ +Start_Rush_Answer_Event_SN(0,1837454011, 0, 0, 0); //开启填空题 +``` +VoteEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|301:S6
302:T2|| +|const char* sInfo|参数字符串|S6:"投票模式,键盘SN,结果,预留,预留"
T2:"投票模式,键盘SN,结果"|| + +##### 接收按键数据部分: + +keyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|12|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"填空内容"|| + +##### 退出功能部分: +```C++ +ExitEvent(12); //带填空题模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"12,OK"|12:带填空题模式切换到空闲模式成功| + +## 模拟测试 +### 模拟测试功能[广播] 函数名称:MockTest_Event 功能:模拟测试功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为自由题功能模式 @@ -769,7 +1300,7 @@ extern"C" __declspec(dllexport) bool Start_TextAnswer_Event_SN( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| |UCHAR iBaseID|基站ID|0~32|| -|int Moed1|模式||| +|int Moed1|模式|1-报告状态
2-按键模拟|| |UCHAR KeyTime|按键开启时间|启动后,多少秒内随机模拟按下按键,0=马上|| |UCHAR GapTime|按键间隔时间|提交成功后,多少秒内再重新提交,模拟修改按键,0=不测试|| @@ -778,12 +1309,52 @@ extern"C" __declspec(dllexport) bool Start_TextAnswer_Event_SN( ```C++ extern"C" __declspec(dllexport) bool MockTest_Event( UCHAR iBaseID, - int Moed1 = 1, - UCHAR KeyTime = 1, - UCHAR GapTime = 1); //模拟测试[1 报告状态] + int Moed1, + UCHAR KeyTime, + UCHAR GapTime); //模拟测试[1 报告状态] ``` -## 异步测验功能[广播] +#### 样例: +样例目的:启动模拟测试 +##### 启动功能部分: +```C++ +MockTest_Event(0, 1, 0, 0); //开启模拟测试 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|9|模拟测试| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|9|| +|int RxMode|预留|0|| +|const char* sInfo|"67,1837454011,1.0,99"|"键盘型号,键盘SN,软件版本,电压或电量"|| + +##### 退出功能部分: +```C++ +ExitEvent(9); //带模拟测试模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"9,OK"|9:带模拟测试模式切换到空闲模式成功| + +## 异步测验 +### 异步测验功能[广播] 函数名称:TestMode_Event 功能:异步测验功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为异步测验功能模式 @@ -791,8 +1362,8 @@ extern"C" __declspec(dllexport) bool MockTest_Event( | **参数名称** | **参数说明** | **范围** | **备注** | |---|---|---|---| |UCHAR iBaseID|基站ID|0~32|| -|int Moed|模式||| -|USHORT TestNum|||| +|int Moed|预留||| +|USHORT TestNum|测试题目数量||| 接口代码: @@ -803,6 +1374,45 @@ extern"C" __declspec(dllexport) bool TestMode_Event( USHORT TestNum); ``` +#### 样例: +样例目的:启动异步测验,自动测试10道题目 +##### 启动功能部分: +```C++ +TestMode_Event(0, 0, 10); //开启异步测验 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|14|异步测验| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|14|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"1,1,0,0"|"题目编号,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(0); //切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"0,OK"|0:切换到空闲模式成功| + ## 多题型模式 ### 启动多题型模式 函数名称:Start_Multiple_Questions_Event @@ -927,8 +1537,8 @@ extern"C" __declspec(dllexport) bool Custom_Questions_Event( UCHAR iBaseID, const char* sInfo); ``` - -## 开启快速配对功能[广播] +## 快速配对 +### 开启快速配对功能[广播] 函数名称:QuickMatch 功能:开启快速配对功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为开启快速配对功能模式 @@ -942,7 +1552,7 @@ extern"C" __declspec(dllexport) bool Custom_Questions_Event( extern"C" __declspec(dllexport) bool QuickMatch(UCHAR iBaseID); ``` -## 开启快速配对功能[内部接口] +### 开启快速配对功能[内部接口] 函数名称:QuickMatch_Pro 功能:开启快速配对功能[广播] 说明:把SDK管理的所有基站的在线键盘设置为开启快速配对功能模式 @@ -1028,7 +1638,7 @@ extern"C" __declspec(dllexport) bool GetKeyNameTxt_C100B_S6( ULONG KeySN); ``` -### 设置键盘评分[积分] +## 设置键盘评分[积分] 函数名称:SetKeyScore 功能:设置键盘评分[积分] 参数说明: @@ -1051,7 +1661,7 @@ extern"C" __declspec(dllexport) bool SetKeyScore( char* Score); ``` -### 键盘自定义标题字符串[第二行] +## 键盘自定义标题字符串[第二行] 函数名称:SetKeyTitleTxt2 功能:设置键盘自定义标题字符串[第二行] 参数说明: @@ -1076,7 +1686,7 @@ extern"C" __declspec(dllexport) bool SetKeyTitleTxt2( const char* Txt); ``` -### 键盘自定义标题字符串[第三行] +## 键盘自定义标题字符串[第三行] 函数名称:SetKeyTitleTxt3 功能:设置键盘自定义标题字符串[第三行] 参数说明: @@ -1099,7 +1709,7 @@ extern"C" __declspec(dllexport) bool SetKeyTitleTxt3( const char* Txt); ``` -### 键盘自定义评分[积分]和标题字符串[第二行] +## 键盘自定义评分[积分]和标题字符串[第二行] 函数名称:SetKeyScreTxt2 功能:设置键盘自定义评分[积分]和标题字符串[第二行] 参数说明: @@ -1128,7 +1738,7 @@ extern"C" __declspec(dllexport) bool SetKeyScreTxt2( const char* Txt); ``` -### 键盘自定义短信 +## 键盘自定义短信 函数名称:SetKeyMessage 功能:设置键盘自定义短信 参数说明: diff --git a/通讯协议-SDK应用部分[内部].md b/通讯协议-SDK应用部分[内部].md index 7535fdc..c56f043 100644 --- a/通讯协议-SDK应用部分[内部].md +++ b/通讯协议-SDK应用部分[内部].md @@ -487,12 +487,11 @@ params:{} |**Json字段**| **字段含义** | **赋值及含义**| | --- | --- | --- | -|bindMode| 签到模式| 1:指定键签到
2:PIN码签到(默认值) | -| lessMode | 预留| 0:(默认值)| +| bindMode | 签到模式| 1:指定键签到
2:PIN码签到(默认值) | | modifyMode | 修改模式 | 0:不可修改
1:可以修改(默认值)| -| limitNumber | 指定位数 | 0:不指定位数(默认值)
1:指定位数 | -| options | 预留 | 10:(默认值)| -| optionalN | 可选数字 | 1≤N≤14 (指定位数才需要设置) | +| lessMode | 预留| 0:(默认值)| +| options | 预留 | 10:(默认值)| +| optionalN | 可选位数 | 1≤N≤14 | | keyValue | 指定按键键值 | 0:未指定[OK键签到]
1:1
2:2
3:3
4:4
5:5
6:6
7:7
8:8
9:9
10:0
11:上键
12:下键
13:OK
14:ESC
15: Menu | | tipTitle | 提示标题 | 字符串,长度最多不超过16个字节| -- libgit2 0.21.4