子佩CC301二次开发接口文档

子佩录音盒语音盒CC301开发文档@gmail.com1前言1.1编写此文件目的说明怎么样通过API控制CC301，以便第三方软件能更好利用CC301（如：CRM系统，办公软件等）无缝连接。建议选择WORD菜单的”视图”-”文档结构图”的方式来浏览该文档的结构图1.2通用说明以下提到的‘PSTN’为公共电话交换网，也就为接在设备line口的线路。以下提到的话机/电话机为接在设备phone口的设备(如：普通模拟电话机/模拟交换机)。以下提到的内线也就为接在phone的设备(如：普通模拟电话机/模拟交换机)。以下提到的PC为接着CC301设备的电脑。以下提到的参数类型BRIINT64-表示有符号64bit(8字节)BRIINT32-表示有符号32bit(4字节)BRIUINT32-表示无符号32bit(4字节)BRIINT16-表示有符号16bit(2字节)BRIUINT16-表示有符号16bit(2字节)BRIBYTE8-表示无符号8bit(1字节)BRICHAR8-表示有符号8bit(1字节)BRIPCHAR8-表示字符串指针(ANSI)BRIPSHORT16-表示字符串指针(UNICODE)以下提到的[in]表示该参数为输入。以下提到的[out]表示该参数为输出。以下提到的[in,out]表示该参数为输入也可以做输出。以下提到的音量设置里的默认音量都为100，如果设置为200表示把音量放大一倍,如果为50就表示缩小一半,如果设置为0就表示为静音，如果为10000就表示把音量放大100倍。子佩录音盒语音盒CC301开发文档的字长定义不一样，如：有些int为32位,有些int为16位有些long为32位,有些long为64位-使用前请仔细查阅该编译器说明2.使用保留的参数值时都必须使用0,保留的字符参数为空字符，如：””3.最后一次函数执行的错误可以使用QNV_GetLastError来获取,返回32位的错误值，具体错误原因查看错误文档定义。函数原型:BRIINT32BRISDKLIBAPIQNV_GetLastError();1.4安装驱动方式一：插入设备，windows会提示有新硬件插入，根据windows向导选择driver目录下相应的驱动。方式二：插入设备，windows会提示有新硬件插入，取消该窗口，执行开发包driver目录下相应的驱动备注：当安装好驱动后，如果在主机换USB口后如果windows提示有新硬件插入，需要重新安装.2接口函数2.1打开设备(QNV_OpenDevice)2.1.1功能描述(Description)打开CC301设备/声卡模块/网络通讯模块2.1.2函数原型(Function)BRIINT32QNV_OpenDevice(/*[in]*/BRIUINT32uDevType,/*[in]*/BRIUINT32uValue,/*[in]*/BRICHAR8*pValue);子佩录音盒语音盒CC301开发文档返回值(ReturnValues)大于0表示成功,其它表示失败.2.1.4参数描述(Parametersdescription)uDevType[in]指定需要打开的设备类型2.1.4.1打开CC301设备模块ODT_LBRIDGE功能描述(Description)打开CC301设备模块参数介绍(Parameters)[in]nValue打开cc301设备参数0—打开所有CC301设备其它—打开指定数量的CC301设备[in]pValue–保留返回值(ReturnValues)小于0表示失败，其它返回打开的设备数量备注(Remarks)无例如(Example)QNV_OpenDevice(ODT_LBRIDGE,0,0);-打开全部CC301设备QNV_OpenDevice(ODT_LBRIDGE,16,0);-打开最前面16个CC301设备,如果设备少与16个就返回实际一共打开的数量2.1.4.2打开声卡模块ODT_SOUND功能描述(Description)打开声卡模块参数介绍(Parameters)[in]nValue–保留子佩录音盒语音盒CC301开发文档页[in]pValue–保留返回值(ReturnValues)大于0表示成功,其它表示失败备注(Remarks)无例如(Example)QNV_OpenDevice(ODT_SOUND,0,0);2.1.4.3打开网络CC模块ODT_CC功能描述(Description)打开网络即时消息/P2P语音/文件的CC模块参数介绍(Parameters)[in]nValue–保留[in]pValue指定CC模块的license字符返回值(ReturnValues)大于0表示成功,其它表示失败备注(Remarks)-非特殊需求的用户使用”quniccub_x”为license例如(Example)QNV_OpenDevice(ODT_CC,0,“quniccub_x”);2.1.5相关函数(SeeAlso)QNV_CloseDevice2.2关闭设备(QNV_CloseDevice)2.2.1功能描述(Description)关闭指定的设备模块子佩录音盒语音盒CC301开发文档函数原型(Function)2.2.3返回值(ReturnValues)有符号32bit位,大于0表示成功，其它表示失败.2.2.4参数描述(Parametersdescription)uDevType[in]指定需要打开的设备类型2.2.4.1关闭CC301设备模块ODT_LBRIDGE功能描述(Description)关闭CC301设备模块参数介绍(Parameters)[in]nValue–保留返回值(ReturnValues)大于0表示成功,其它表示失败备注(Remarks)无例如(Example)QNV_CloseDevice(ODT_LBRIDGE,0);2.2.4.2关闭声卡模块ODT_SOUND功能描述(Description)关闭声卡模块参数介绍(Parameters)[in]nValue–保留返回值(ReturnValues)BRIINT32QNV_CloseDevice(/*[in]*/BRIUINT32uDevType,/*[in]*/BRIUINT32uValue);子佩录音盒语音盒CC301开发文档表示成功,其它表示失败备注(Remarks)无例如(Example)QNV_CloseDevice(ODT_SOUND,0);2.2.4.3关闭网络CC模块ODT_CC功能描述(Description)网络即时消息/P2P语音/文件的CC模块参数介绍(Parameters)[in]nValue–保留返回值(ReturnValues)大于0表示成功,其它表示失败备注(Remarks)无例如(Example)QNV_CloseDevice(ODT_CC,0);2.2.4.4关闭指定的通道ODT_CHANNEL功能描述(Description)关闭指定的通道参数介绍(Parameters)[in]nValue–保留返回值(ReturnValues)大于0表示成功,其它表示失败备注(Remarks)无例如(Example)QNV_CloseDevice(ODT_CHANNEL,1);-关闭通道1(第2个通道)子佩录音盒语音盒CC301开发文档获取设备信息(QNV_DevInfo)2.3.1功能描述(Description)获取设备信息2.3.2函数原型(Function)BRIINT32QNV_DevInfo(/*[in]*/BRIINT16nChannelID,/*[in]*/BRIUINT32uDevInfoType);2.3.3返回值(ReturnValues)有符号32bit位-小于等于0表示失败。-其它表示成功2.3.4参数描述(Parametersdescription)nChannelID[in]指定需要获取信息的通道号/USB模块ID–第一个通道nChannelID为0,依次递增uDevInfoType[in]指定需要获取信息的参数类型值2.3.4.1获取USB模块类型QNV_DEVINFO_GETCHIPTYPE功能描述(Description)获取USB模块类型返回值(ReturnValues)小于等于0表示失败，其它表示USB的模块类型备注(Remarks)该功能保留例如(Example)QNV_DevInfo(0,QNV_DEVINFO_GETCHIPTYPE);子佩录音盒语音盒CC301开发文档功能描述(Description)获取USB模块数量返回值(ReturnValues)小于0表示失败，其它返回打开的设备里总共有几个USB芯片备注(Remarks)-该值等同于最后一个通道的设备ID+1.(QNV_DEVINFO_GETDEVID)-某些设备的一个USB芯片具有2个通道,当一个USB芯片只有一个通道时，设备ID就是通道ID例如(Example)QNV_DevInfo(0,QNV_DEVINFO_GETCHIPS);2.3.4.3获取通道类型QNV_DEVINFO_GETTYPE功能描述(Description)获取通道类型返回值(ReturnValues)小于0表示失败，其它返回设备的类型ID,具体ID所指定的信息查看相关定义备注(Remarks)无例如(Example)QNV_DevInfo(0,QNV_DEVINFO_GETTYPE);2.3.4.4获取通道功能模块QNV_DEVINFO_GETMODULE功能描述(Description)获取通道功能模块返回值(ReturnValues)小于0表示失败，返回设备拥有的功能模块备注(Remarks)功能模块如：(详细信息查看专门的设备功能模块定义)DEVMODULE_DOPLAY…子佩录音盒语音盒CC301开发文档例如(Example)QNV_DevInfo(0,QNV_DEVINFO_GETMODULE);2.3.4.5获取通道所在USB芯片中的传输IDQNV_DEVINFO_GETCHIPCHID功能描述(Description)获取通道所在USB芯片中的传输ID返回值(ReturnValues)小于0表示失败，其它返回该通道在USB芯片里的传输ID.(0或者1)备注(Remarks)一个USB芯片模块有可能拥有两个传输通道。-0表示第一个传输通道-1表示第二个传输通道例如(Example)QNV_Dev