博峰系列语音(传真)设备 编程接口(一般常量-数据结构-.pdf

博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)第一章第一章 博峰系列语音博峰系列语音(传真传真)设备编程接口一般常量定义设备编程接口一般常量定义 以下介绍的常量均包含在 BfVoice.h 文件中。#define MAX_CARD_NUM 0 x0008 定义了插入同一台计算机中 BF-VOICE 语音卡的最大数量#define MAX_CHANNEL_NUM 0 x0080 定义了插入同一台计算机中 BF-VOICE 语音卡的所有语音通道的最大数量#define MAX_RESOURCE_NUM 0 x0040 定义了插入同一台计算机中 BF-VOICE 语音卡的所有资源通道的最大数量#define MAX_SERIAL_NUM 0 x0020 定义了 BF-VOICE 语音卡的系列号的最大字节数量#define MAX_DTMF_NUM 0 x0040 定义了所有涉及 DTMF 按键个数的字符串中的最大字符数量，常常只允许 MAX_DTMF_NUM-1 个#define MAX_CID_NUM 0 x0080 定义了接收 FSK 主叫的字符串最大字符数量#define MAX_FSK_NUM 0 x0400 定义了发送 FSK 的字符串中的最大字符数量#define MAX_FILE_NAME_NUM 0 x0080 定义了所有涉及文件名称的字符串中的最大字符数量，常常只允许 MAX_FILE_NAME_NUM-1 个#define MAX_INDEX_BUFFER_NUM 0 x0100 定义了最大索引缓存区放音的数量#define MAX_INDEX_FILE_NUM 0 x0040 定义了最大索引文件放音的数量#define MAX_CONFERENCE_GROUP_NUM 0 x0010 定义了最大会议组的数量#define MAX_CONFERENCE_RESOURCE_NUM 0 x0020 定义了最大会议资源的数量#define MAX_CONFERENCE_GROUP_RESOURCE_NUM 0 x0010 定义了每个通道最大会议资源的数量 下面两个常量用于所有 BF-VOICE 语音卡的函数调用的返回值的判定。#define BF_OK 0 x0000 当调用 BF-VOICE 函数时，如果返回该值，表示调用成功，否则意味出错#define BF_ERROR 0 xFFFF 当调用 BF-VOICE 函数时，如果返回该值，意味出错 下面四个常量用于函数 BF_GetChannelType 的返回值，即通道类型。#define CHANNEL_TYPE_NONE 0 x0000 该值为语音通道的模块类型，表示相应的语音通道没有模块#define CHANNEL_TYPE_USER 0 x0001 该值为语音通道的模块类型，表示相应的语音通道的模块为用户模块 第 1 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)#define CHANNEL_TYPE_TRUNK 0 x0002 该值为语音通道的模块类型，表示相应的语音通道的模块为中继模块#define CHANNEL_TYPE_RECORD 0 x0003 该值为语音通道的模块类型，表示相应的语音通道的模块为录音（高阻）模块 下面四个常量用于函数 BF_GetResourceType 的返回值，即资源类型。#define RESOURCE_TYPE_NONE 0 x0000 该值为资源通道的类型，表示相应的资源通道的不存在#define RESOURCE_TYPE_FAX 0 x0001 该值为资源通道的类型，表示相应的资源通道的类型为传真#define RESOURCE_TYPE_VOIP 0 x0002 该值为资源通道的类型，表示相应的资源通道的类型为 VoIP#define RESOURCE_TYPE_CODEC 0 x0004 该值为资源通道的类型，表示相应的资源通道的类型为编码/解码#define RESOURCE_TYPE_FAX_VOIP 0 x0003 该值为资源通道的类型，表示相应的资源通道的类型为传真和 VoIP#define RESOURCE_TYPE_FAX_CODEC 0 x0005 该值为资源通道的类型，表示相应的资源通道的类型为传真和编码/解码#define RESOURCE_TYPE_VOIP_CODEC 0 x0006 该值为资源通道的类型，表示相应的资源通道的类型为 VoIP 和编码/解码#define RESOURCE_TYPE_FAX_VOIP_CODEC 0 x0007 该值为资源通道的类型，表示相应的资源通道的类型为传真、VoIP 和编码/解码 下面四个常量是用于添加会议函数的参数。#define CONFERENCE_MODE_NONE 0 x0000 该值表示添加的会议通道没有意义#define CONFERENCE_MODE_TALK 0 x0001 该值表示添加的会议通道是主讲通道，该通道的语音与其他同组主讲通道的语音合成 后，送给所有相同组的会议通道。#define CONFERENCE_MODE_LISTEN 0 x0002 该值表示添加的会议通道是只听通道，不能发言。#define CONFERENCE_MODE_RECORD 0 x0003 该值表示添加的会议通道只用于录音。下面六个常量是用于设置录音放音的语音格式函数的参数，如函数 BF_SetPlayVoiceType 和 BF_SetRecordVoiceType。#define VOICE_TYPE_A_LAW 0 x0000 该值表示放音或录音的语音格式是 a-law 的。#define VOICE_TYPE_G726_32K 0 x0001 该值表示放音或录音的语音格式是 32Kbit/s 的 ADPCM。#define VOICE_TYPE_G726_16K 0 x0002 该值表示放音或录音的语音格式是 16Kbit/s 的 ADPCM#define VOICE_TYPE_DIALOGIC_ADPCM 0 x0003 该值表示放音或录音的语音格式是 Dialogic 的 ADPCM。#define VOICE_TYPE_LINEAR_8BIT 0 x0004 /8-bit unsigned 该值表示放音或录音的语音格式是 8 位无符号的 PCM 码。第 2 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)#define VOICE_TYPE_LINEAR_16BIT 0 x0005 /16-bit unsigned 该值表示放音或录音的语音格式是 16 位无符号的 PCM 码。下面两个常量是用于设置录音放音的文件类型函数的参数，如函数 BF_SetPlayVoiceFileType 和 BF_SetRecordVoiceFileType。#define VOICE_FILE_TYPE_NORMAL 0 x0000 该值表示放音或录音的文件类型是纯 PCM 码。#define VOICE_FILE_TYPE_WAVE 0 x0001 该值表示放音或录音的文件类型是 Wave。下面两个常量是用于设置传真分辨率的函数的参数。#define FAX_RESOLUTION_LOW 0 x0000 该值表示发送或接收的传真是低分辨率的。#define FAX_RESOLUTION_FINE 0 x0001 该值表示发送或接收的传真是高分辨率的。下面两个常量是用于设置录音放音终止按键的参数。#define STOP_NOT_DTMF 0 x00 该值表示在放音或录音的过程中，遇到任何按键，都不停止。#define STOP_ANY_DTMF 0 x01 该值表示在放音或录音的过程中，遇到任意按键，立即停止。第二章第二章 博峰系列语音博峰系列语音(传真传真)设备编程接口数据结构定义设备编程接口数据结构定义 以下介绍的数据结构均包含在 BfVoice.h 文件中。1、事件数据结构 typedef struct _BF_MESSAGE_INFO USHORT MessageCode;USHORT ChannelNo;USHORT Parameter6;BF_MESSAGE_INFO,*PBF_MESSAGE_INFO;定义了事件数据结构，即每次取回事件的内容，具体意义如下：MessageCode 占 1 个字，事件号码。ChannelNo 占 1 个字，发生事件的通道。Parameter 占 6 个字，事件参数，对于不同的事件，其内容不同，具体参见相关的事件类型说明章节。2、标准信号音参数数据结构 typedef struct _BF_TONE_INFO unsigned short DialToneMinTotalTime;unsigned short BusyToneMaxTotalTime;unsigned short BusyToneMinTotalTime;第 3 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)unsigned short BusyToneRatio;unsigned short BusyToneErrorBetweenTwo;unsigned short BusyToneTotalTimes;unsigned short BackToneMaxTotalTime;unsigned short BackToneMinTotalTime;unsigned short BackToneRatio;unsigned short BackToneErrorBetweenTwo;unsigned short BackToneTotalTimes;BF_TONE_INFO,*PBF_TONE_INFO;_BF_TONE_INFO 结构中的各项含义如下：代号 缺省值 含义 DialToneMinTotalTime 拨号音持续最小时间(毫秒)2500 BusyToneMaxTotalTime 最大忙音周期时间(毫秒)1500 BusyToneMinTotalTime 最小忙音周期时间(毫秒)500 BusyToneRatio 忙音周期占空比 50 BusyToneErrorBetweenTwo 两个忙音周期的误差比 10 BusyToneTotalTimes 忙音周期数量 3 BackToneMaxTotalTime 最大回铃音周期时间(毫秒)6000 BackToneMinTotalTime 最小回铃音周期时间(毫秒)4000 BackToneRatio 回铃音周期占空比 20 BackToneErrorBetweenTwo 两个回铃音周期的误差比 10 BackToneTotalTimes 回铃音周期数量 3 3、传真信息参数数据结构 typedef struct _BF_FAX_INFORMATION unsigned short SignalRate;unsigned short Resolution;unsigned short TwoDimensional;unsigned short RecordWidth;unsigned short RecordLength;BF_FAX_INFORMATION,*PBF_FAX_INFORMATION;_BF_FAX_INFORMATION 结构中的各项含义如下：代号 含义 SignalRate 传真速率，即波特率 Resolution 传真分辨率 03.58 行/毫米 17.7l 行/毫米 TwoDimensional 是否二维编码 0一维编码 1二维编码 RecordWidth 每行的点阵数量 RecordLength 每页的长度，单位毫米，取值如下：0 xFFFF 长度不限 其他 单位为毫米的长度 第 4 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)第三章第三章 博峰系列语音博峰系列语音(传真传真)设备编程接口事件类型定义设备编程接口事件类型定义 本章介绍的结构 BF_MESSAGE_INFO 中 MessageCode 的种类，以及与 MessageCode 相对应的参数 Parameter 的意义。以下介绍的常量均包含在 BFVoice.h 文件中。#define MESSAGE_HAVE_CID_FSK 0 x0000 有 FSK 方式的主叫事件，收到该事件的通道可以调用函数 BF_GetFskCallerID 来获取主叫 号码，呼叫时间和主叫名称等相关信息。#define MESSAGE_HAVE_CID_DTMF 0 x0001 有 DTMF 方式的主叫事件，收到该事件的通道可以调用函数 BF_BF_GetDtmfCallerID 来获取 主叫号码信息，DTMF 当时的主叫信息只有主叫号码。#define MESSAGE_HAVE_DTMF 0 x0002 当识别到 DTMF 按键时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。如果要想得到该事件，必须先调用函数 BF_StartDetectDTMF。收到该事件的通道可以调用 函数 BF_BF_ BF_GetDTMFKey 来获取收到的 DTMF 按键。#define MESSAGE_PLAY_VOICE_END 0 x0003 放音结束事件，当全部放音数据放完时，BF-VOICE 语音卡发送该事件，并停止放音，该事 件的参数 Parameter 没有意义。#define MESSAGE_PLAY_VOICE_EXIT 0 x0004 放音中断事件，当打开或读取放音文件出错，或收到放音停止的 DTMF 时，BF-VOICE 语音 卡发送该事件，并停止放音，该事件的参数 Parameter 没有意义。#define MESSAGE_RECORD_VOICE_END 0 x0005 录音结束事件，当所需数量的录音数据录完时，BF-VOICE 语音卡发送该事件，并停止录音，该事件的参数 Parameter 没有意义。#define MESSAGE_RECORD_VOICE_EXIT 0 x0006 录音中断事件，当创建或写录音文件出错，或收到录音停止的 DTMF 时，BF-VOICE 语音卡 发送该事件，并停止录音，该事件的参数 Parameter 没有意义。#define MESSAGE_GENERATE_SIGNAL_END 0 x0007 发送信号音结束事件，当信号音发送完成时，BF-VOICE 语音卡发送该事件，并停止发送信 号音，该事件的参数 Parameter 没有意义。#define MESSAGE_GENERATE_SIGNAL_EXIT 0 x0008 发送信号音中断事件，当收到中断发送信号音的 DTMF 时，BF-VOICE 语音卡发送该事件，并停止发送信号音，该事件的参数 Parameter 没有意义。#define MESSAGE_GENERATE_DTMF_END 0 x0009 当发送完所有需要发送的 DTMF 按键时，BF-VOICE 语音卡发送该事件，该事件的参数。Parameter 没有意义。没有命令可以中断发送 DTMF 命令。#define MESSAGE_SEND_FSK_END 0 x000A 当发送 FSK 完毕，BF-VOICE 语音卡发送该事件。#define MESSAGE_HAVE_DIAL_TONE 0 x000B 当模块有标准拨号音时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。如果要想得到该事件，必须先调用函数 BF_StartDetectDialTone。#define MESSAGE_HAVE_BUSY_TONE 0 x000C 当模块有标准忙音时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。如果要想得到该事件，必须先调用函数 BF_StartDetectBusyTone。第 5 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)#define MESSAGE_HAVE_BACK_TONE 0 x000D 当模块有标准回铃音时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。如果要想得到该事件，必须先调用函数 BF_StartDetectBackTone。#define MESSAGE_HAVE_TONE_DATA 0 x000E 当模块有信号音数据时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 的第一 个字为信号音数据。#define MESSAGE_HAVE_HELLO_VOICE 0 x000F 当识别到话音时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。如果要想得到该事件，必须先调用函数 BF_StartDetectHelloVoice。#define MESSAGE_HAVE_SILENCE_DATA 0 x0010 当启动静音识别时，每当 BF-VOICE 语音卡完成给定时间内的识别时发送该事件，该事 件的参数 Parameter 的第一个字表示静音数据。如果要想得到该事件，必须先调用函数 BF_StartDetectSilence。#define MESSAGE_HAVE_BACK_TONE_HALT 0 x0011 表示回铃音已经停止#define MESSAGE_HAVE_SPECIAL_SIGNAL 0 x0012 在识别特殊信号音时，表示有符合持续条件的信号音#define MESSAGE_HAVE_FSK_DATA 0 x0013 当识别到 FSK 信息时，发送该事件#define MESSAGE_HAVE_TIME_OUT 0 x0014 当设定的超时到达时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。如果要想得到该事件，必须先调用函数 BF_StartTimeOut。#define MESSAGE_PLAY_CIRCLE_FIRST_END 0 x0015 在循环缓存区放音时，表示上一半缓存区已经放音完毕#define MESSAGE_PLAY_CIRCLE_SECOND_END 0 x0016 在循环缓存区放音时，表示下一半缓存区已经放音完毕#define MESSAGE_RECORD_CIRCLE_FIRST_END 0 x0017 在循环缓存区录音时，表示上一半缓存区已经录音完毕#define MESSAGE_RECORD_CIRCLE_SECOND_END 0 x0018 在循环缓存区录音时，表示下一半缓存区已经录音完毕#define MESSAGE_AUTO_DIAL_NO_DIAL_TONE 0 x0019 在调用函数 BF_AutoDialOut 等自动拨号后，收到该事件，表示没有拨号音。#define MESSAGE_AUTO_DIAL_NONE_LISTEN 0 x001A 在调用函数 BF_AutoDialOut 等自动拨号后，收到该事件，表示对方没人接听。#define MESSAGE_AUTO_DIAL_HAVE_BUSY 0 x001B 在调用函数 BF_AutoDialOut 等自动拨号后，收到该事件，表示对方占线。#define MESSAGE_AUTO_DIAL_HOOK_OFF 0 x001C 在调用函数 BF_AutoDialOut 自动拨号后，收到该事件，表示对方摘机。#define MESSAGE_AUTO_DIAL_HOOK_OFF_BY_HELLO 0 x001D 在调用函数 BF_AutoDialOutWithHello 自动拨号后，收到该事件，表示对方摘机。#define MESSAGE_AUTO_DIAL_HOOK_OFF_BY_POLE 0 x001E 在调用函数 BF_AutoDialOutWithPole 自动拨号后，收到该事件，表示对方摘机。#define MESSAGE_USER_HOOK_OFF 0 x1001 当用户模块有摘机动作时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有 意义。第 6 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)#define MESSAGE_USER_HOOK_ON 0 x1002 当用户模块有挂机动作时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有 意义。#define MESSAGE_USER_PICK_UP 0 x1003 当用户模块有拍插动作时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有 意义，所谓的拍插动作，就是当用户模块由摘机状态转换到挂机状态，然后再回到摘机 状态的总共时间小于一定时间的动作，该时间缺省值是 500 毫秒，该值可由函数 BF_SetUserPickUpTime()重新设置。#define MESSAGE_USER_RING_END 0 x1004 当用户模块的振铃完成时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有 意义。#define MESSAGE_TRUNK_RING 0 x2000 当中继模块有振铃时，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter0中包含当 前振铃次数。#define MESSAGE_TRUNK_POLE 0 x2001 当中继模块有极性反转时，BF-VOICE 语音卡发送该事件，该事件参数 Parameter 没有意义。#define MESSAGE_TRUNK_PICK_UP_END 0 x2002 当中继模块完成拍插动作后，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有 意义。#define MESSAGE_TRUNK_RING_END 0 x2003 当中继模块停止振铃后，BF-VOICE 语音卡发送该事件，该事件的参数 Parameter 没有意义。#define MESSAGE_RECORD_OPEN_CIRCLE 0 x3001 当录音模块没有接电话线时，BF-VOICE 语音卡发送该事件。#define MESSAGE_RECORD_NO_OPEN_CIRCLE 0 x3002 当录音模块从没有接电话线状态变为有接电话线状态时时，BF-VOICE 语音卡发送该事件。#define MESSAGE_RECORD_HOOK_OFF 0 x3004 当录音模块有摘机动作时，BF-VOICE 语音卡发送该事件，该事件参数 Parameter 没有意义。#define MESSAGE_RECORD_HOOK_ON 0 x3005 当录音模块有挂机动作时，BF-VOICE 语音卡发送该事件，该事件参数 Parameter 没有意义。#define MESSAGE_RECORD_RING 0 x3006 当录音模块有振铃时，BF-VOICE 语音卡发送该事件，该事件参数 Parameter0中包含当前 振铃次数。#define MESSAGE_RECORD_RING_END 0 x3007 当录音模块停止振铃时，BF-VOICE 语音卡发送该事件，该事件参数 Parameter 没有意义。#define MESSAGE_SEND_FAX_OK 0 x5000 当发送传真正常完成时，BF-VOICE 语音卡发送该事件。#define MESSAGE_SEND_FAX_ERROR 0 x5001 当发送传真出错时，BF-VOICE 语音卡发送该事件。#define MESSAGE_RECEIVE_FAX_OK 0 x5002 当接收正常完成时，BF-VOICE 语音卡发送该事件。#define MESSAGE_RECEIVE_FAX_ERROR 0 x5003 当接收传真出错时，BF-VOICE 语音卡发送该事件。#define MESSAGE_FAX_HAVE_REMOTE_TEL_NO 0 x5004 第 7 页 共 8 页 博峰系列语音 传真 设备编程接口 一般常量 数据结构 事件常量 说明()(-)在接收或发送传真过程中，收到对方传真号码时，发送该消息，应用程序可以调用函数 BF_GetRemoteTelNo 来取得对方传真号码#define MESSAGE_FAX_HAVE_INFORMATION 0 x5005 在接收或发送传真过程中，确认双方传真信息时，发送该消息，应用程序可以调用函数 BF_GetFaxInformation 来取得传真信息#define MESSAGE_FAX_SEND_PAGE_END 0 x500A 在发送传真过程中，如果一页数据发送完毕，系统发送该事件给应用程序。#define MESSAGE_FAX_RECEIVE_PAGE_END 0 x500B 在接收传真过程中，如果一页数据接收完毕，系统发送该事件给应用程序。#define MESSAGE_FAX_SEND_PAGE_START 0 x500C 在发送传真过程中，如果一页数据开始发送，系统发送该事件给应用程序。#define MESSAGE_FAX_RECEIVE_PAGE_START 0 x500D 在接收传真过程中，如果一页数据开始接收，系统发送该事件给应用程序。第 8 页 共 8 页