子佩USB录音盒语音盒开发接口文档

文档名    子佩CC301 API开发接口文档        起草人    Juju.chen
文档版本    2.3        起草日期    2009-09-01
            更新日期    2011-04-25
                
技术支持方式    9421766@gmail.com            

前言
编写此文件目的
    说明怎么样通过API控制CC301，以便第三方软件能更好利用子佩录音盒CC301（如：CRM系统，办公软件等）无缝连接。
    建议选择WORD菜单的”视图”->”文档结构图”的方式来浏览该文档的结构图

通用说明
以下提到的‘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倍。

开发时需要注意的细节
    1.不同的编译器对int,long的字长定义不一样，
    如：有些int为32位,有些int为16位
    有些long为32位,有些long为64位
    - 使用前请仔细查阅该编译器说明
    2.使用保留的参数值时都必须使用0,保留的字符参数为空字符，如：””
    3.最后一次函数执行的错误可以使用QNV_GetLastError来获取,返回32位的错误值，具体错误原因查看错误文档定义。
    函数原型: BRIINT32    BRISDKLIBAPI    QNV_GetLastError();
安装驱动
方式一：插入设备，windows会提示有新硬件插入，根据windows向导选择driver目录下相应的驱动。
方式二：插入设备，windows会提示有新硬件插入，取消该窗口，执行开发包driver目录下相应的驱动
备注：
    当安装好驱动后，如果在主机换USB口后如果windows提示有新硬件插入，需要重新安装.
接口函数
打开设备 (QNV_OpenDevice)
功能描述 ( Description )
    打开CC301设备/声卡模块/网络通讯模块
函数原型 ( Function )
BRIINT32 QNV_OpenDevice(
/*[in]*/ BRIUINT32 uDevType,
/*[in]*/ BRIUINT32 uValue,
/*[in]*/ BRICHAR8 *pValue);

返回值 ( Return Values )
        大于0表示成功,其它表示失败.
            
参数描述 (Parameters description)
uDevType
    [in] 指定需要打开的设备类型
打开CC301设备模块ODT_LBRIDGE
    功能描述 ( Description )
            打开CC301设备模块
    参数介绍 ( Parameters )
    [in] nValue    
                    打开cc301设备参数
                        0    —    打开所有CC301设备
                        其它 —    打开指定数量的CC301设备
            [in] pValue        – 保留
    返回值 ( Return Values )
    小于0表示失败，其它返回打开的设备数量
    备注 (Remarks)
无
    例如 (Example)
    QNV_OpenDevice(ODT_LBRIDGE,0,0);
- 打开全部CC301设备
    QNV_OpenDevice(ODT_LBRIDGE,16,0);
    - 打开最前面16个CC301设备,如果设备少与16个就返回实际一共打开的数量
        
打开声卡模块ODT_SOUND
    功能描述 ( Description )
            打开声卡模块
    参数介绍 ( Parameters )
    [in] nValue        – 保留
            [in] pValue        – 保留
    返回值 ( Return Values )
    大于0表示成功,其它表示失败
    备注 (Remarks)
无
    例如 (Example)
    QNV_OpenDevice(ODT_SOUND,0,0);
    
打开网络CC模块ODT_CC
    功能描述 ( Description )
            打开网络即时消息/P2P语音/文件的CC模块
    参数介绍 ( Parameters )
    [in] nValue        – 保留
            [in] pValue    
                    指定CC模块的license 字符
    返回值 ( Return Values )
    大于0表示成功,其它表示失败
    备注 (Remarks)
- 非特殊需求的用户使用”quniccub_x”为license
    例如 (Example)
    QNV_OpenDevice(ODT_CC,0, “quniccub_x”);
            
相关函数 ( See Also )
    QNV_CloseDevice
    

关闭设备(QNV_CloseDevice)
功能描述 ( Description )
    关闭指定的设备模块
函数原型 ( Function )
BRIINT32 QNV_CloseDevice(
/*[in]*/ BRIUINT32 uDevType,
/*[in]*/ BRIUINT32 uValue);

    
    
    
返回值 ( Return Values )
        有符号32bit位,大于0表示成功，其它表示失败.
    
参数描述 (Parameters description)
uDevType
    [in] 指定需要打开的设备类型
关闭CC301设备模块ODT_LBRIDGE
    功能描述 ( Description )
            关闭CC301设备模块
    参数介绍 ( Parameters )
    [in] nValue        – 保留
    返回值 ( Return Values )
    大于0表示成功,其它表示失败
    备注 (Remarks)
无
    例如 (Example)
    QNV_CloseDevice(ODT_LBRIDGE,0);
关闭声卡模块ODT_SOUND
    功能描述 ( Description )
            关闭声卡模块
    参数介绍 ( Parameters )
    [in] nValue        – 保留
    返回值 ( Return Values )
    大于0表示成功,其它表示失败
    备注 (Remarks)
无
    例如 (Example)
    QNV_CloseDevice(ODT_SOUND,0);
关闭网络CC模块ODT_CC 
    功能描述 ( Description )
            网络即时消息/P2P语音/文件的CC模块
    参数介绍 ( Parameters )
    [in] nValue        – 保留
    返回值 ( Return Values )
    大于0表示成功,其它表示失败
    备注 (Remarks)
无
    例如 (Example)
    QNV_CloseDevice(ODT_CC,0);

关闭指定的通道ODT_CHANNEL 
    功能描述 ( Description )
            关闭指定的通道
    参数介绍 ( Parameters )
    [in] nValue        – 保留
    返回值 ( Return Values )
    大于0表示成功,其它表示失败
    备注 (Remarks)
无
    例如 (Example)
    QNV_CloseDevice(ODT_CHANNEL,1);
        - 关闭通道1(第2个通道)

获取设备信息 (QNV_DevInfo)
功能描述 ( Description )
    获取设备信息
函数原型 ( Function )
BRIINT32 QNV_DevInfo (
/*[in]*/BRIINT16 nChannelID,
/*[in]*/BRIUINT32 uDevInfoType);

返回值 ( Return Values )
        有符号32bit位
小于等于0表示失败。
其它表示成功
    
参数描述 (Parameters description)
    nChannelID 
[in] 指定需要获取信息的通道号/USB模块ID 
    – 第一个通道nChannelID为0,依次递增
    uDevInfoType 
    [in] 指定需要获取信息的参数类型值
获取USB模块类型QNV_DEVINFO_GETCHIPTYPE
    功能描述 ( Description )
            获取USB模块类型
    返回值 ( Return Values )
    小于等于0表示失败，其它表示USB的模块类型
    备注 (Remarks)
该功能保留
    例如 (Example)
    QNV_DevInfo(0, QNV_DEVINFO_GETCHIPTYPE);
    
获取USB模块数量QNV_DEVINFO_GETCHIPS
    功能描述 ( Description )
            获取USB模块数量
    返回值 ( Return Values )
    小于0表示失败，其它返回打开的设备里总共有几个USB芯片
    备注 (Remarks)
    - 该值等同于最后一个通道的设备ID+1.( QNV_DEVINFO_GETDEVID)
    - 某些设备的一个USB芯片具有2个通道,当一个USB芯片只有一个通道时，设备ID就是通道ID
    例如 (Example)
    QNV_DevInfo(0, QNV_DEVINFO_GETCHIPS);
获取通道类型QNV_DEVINFO_GETTYPE
    功能描述 ( Description )
            获取通道类型
    返回值 ( Return Values )
    小于0表示失败，其它返回设备的类型ID,具体ID所指定的信息查看相关定义
    备注 (Remarks)
无
    例如 (Example)
    QNV_DevInfo(0, QNV_DEVINFO_GETTYPE);
    
获取通道功能模块QNV_DEVINFO_GETMODULE
    功能描述 ( Description )
            获取通道功能模块
    返回值 ( Return Values )
    小于0表示失败，返回设备拥有的功能模块
    备注 (Remarks)
南京子佩科技公司  为你 提供录音盒2次开发接口
QQ9469740