**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”所指示的臨時文件,上層應用在處理完畢后,需要主動刪除該臨時文件。