**2.4.1、接口方法**
**2.4.1.1文件传输**
函数: **BRAC_TransFile**(INT dwUserId, STRING lpLocalPathName, INT wParam, INT lParam, INT dwFlags)
功能: 传送文件给指定用户
返回值:>0表示任务ID号(可利用该ID查询文件传输进度),否则表示出错。
参数:
dwUserId: 整型值,目标用户编号,只针对某一个用户,不能为-1(所有人)
lpLocalPathName: 本地文件名,含路径
wParam: 整型值,附带参数1,便于上层应用扩展
lParam: 整型值,附带参数2
dwFlags: 整型值,特殊功能标志,参考:“BRAC_TransBufferEx”方法
备注:
该方法传输效率与“BRAC_TransBufferEx”方法相同,只是在SDK内部封装了文件的分组传输功能,实现对上层应用的透明,简化上层应用的开发难度。
**2.4.1.2、查询传输任务相关信息**
函数: **BRAC_QueryTransTaskInfo**(INT dwUserId, INT dwTaskId, INT infoname)
功能: 查询与传输任务相关的信息,如传输进度、传输状态、传输码率等
参数:
dwUserId:整型值,任务发起者用户编号(并非传输目标用户编号)
dwTaskId:整型值,需要查询的任务编号(SDK内核产生任务ID)
infoname 整型值,需要查询的信息代码(见anychatsdk.js 传输信息参数)
返回值:返回查询的信息
说明:
通过调用该函数,可以查询指定传输任务编号的缓冲区传输情况。用户编号与任务编号组合才具有唯一性,不同的用户可能存在相同的任务编号。
**2.4.1.3、取消传输任务**
函数: **BRAC_CancelTransTask**(dwUserId, dwTaskId)
功能: 取消文件传输任务
参数:
dwUserId:整型值,任务发起者用户编号(并非传输目标用户编号)
dwTaskId:整型值,需要取消的任务编号(SDK内核产生任务ID)
返回值:0表示查询成功,否则为出错代码
**2.4.1.4、传送文件(扩展)**
函数: **BRAC_TransFileEx**(lpTaskGuid, dwUserId, lpLocalPathName, dwFlags, lpStrParam)
功能: 传送文件给指定用户(扩展)
返回值:>0表示任务ID号(可利用该ID查询文件传输进度),否则表示出错。
参数:
lpTaskGuid: 任务Guid,可用BRAC_GetSDKOption生成
dwUserId: 整型值,目标用户编号,只针对某一个用户,不能为-1(所有人)
lpLocalPathName: 本地文件名,含路径
dwFlags: 整型值,特殊功能标志,参考:“BRAC_TransBufferEx”方法
lpStrParam: 预留参数,可传空字符串或json字符串实现特殊功能
**2.4.1.5、查询传输任务相关信息(扩展)**
函数:**BRAC_QueryTransTaskInfoEx**(lpTaskGuid, dwInfoName)
功能: 查询与传输任务相关的信息,如传输进度、传输状态、传输码率等
参数:
lpTaskGuid:任务Guid,与调用文件传输时传入的相同
dwInfoName:整型值,需要查询的信息代码(见anychatsdk.js 传输信息参数)
返回值:返回查询的信息
说明:
通过调用该函数,可以查询指定传输任务编号的缓冲区传输情况。用户编号与任务编号组合才具有唯一性,不同的用户可能存在相同的任务编号。
**2.4.1.6、取消传输任务(扩展)**
函数: **BRAC_CancelTransTaskEx**(lpTaskGuid, dwFlags, dwErrorCode)
功能: 取消文件传输任务
参数:
lpTaskGuid: 任务Guid,与调用文件传输时传入的相同
dwFlags: 预留参数,可传0
dwErrorCode: 错误码
返回值:0表示查询成功,否则为出错代码
**2.4.2、回调函数**
OnAnyChatTransFile(dwUserId, lpFileName, lpTempFilePath, dwFileLength, wParam, lParam, dwTaskId)
参数:
dwUserid: 用户ID,指示发送用户
lpFileName: 文件名(含扩展名,不含路径)
lpTempFilePath:接收完成后,SDK保存在本地的临时文件(包含完整路径)
dwFileLength: 文件总长度
AnyChat for Web SDK 开发手册 佰锐科技 版权所有
第 30 页 共 74 页
wParam: 附带参数1
lParam: 附带参数2
dwTaskId: 该次文件传输对应的任务编号
说明:
当收到其它用户使用“BRAC_TransFile”方法发送的文件时,将会触发该事件回调函数。
特别提示:本SDK不会删除“lpTempFilePath”所指示的临时文件,上层应用在处理完毕后,需要主动删除该临时文件。