創建文件上傳任務 · anychat_sdk_harmony_doc

### **創建上傳文件任務** AnyChatUploadTask.createFileUploadTask(uploadOpt: AnyChatFileUploadOpt, e: AnyChatFileUploadEvent) #### 接口說明：創建文件上傳到服務器的任務（注：需要初始化） #### 接口參數簡介： | 名稱 | 類型 | 說明 | 是否必須 | | --- | --- | --- | --- | | uploadOpt| AnyChatFileUploadOpt | 文件上傳配置類 | 是 | | e | AnyChatFileUploadEvent | 文件上傳狀態與結果回調 | 是 | #### AnyChatFileUploadOpt 文件上傳配置類簡介： | 名稱 | 類型 | 說明 | 是否必須 | | --- | --- | --- | --- | | localPath| string| 要上傳文件的絕對路徑 | 是 | | intervalTime| number | 返回文件上傳狀態時間間隔，單位：s | 否 | | filename| string | 指定文件上傳后的目標文件名 | 否 | | category| string | 表示文件上傳分類子目錄,通過設置改字段可將文件上傳到不同分類子目錄中 | 否 | | encryptionKey| string | 上傳一個已加密錄像視頻文件(參考錄制章節)，在上傳到服務器時，該文件將自動被解密。根據加密的錄像視頻文件的加密秘鑰，設置相同的解密密鑰 | 否 | | isOverlayUpload|boolean| 是否覆蓋上傳(默認值true相同文件覆蓋上傳) | 否 | | maxBitrate| number| 文件上傳傳輸最大碼率控制(為0時表示不限制，以最快速率傳輸[默認]；否則表示限制碼率，單位為：bps) | 否 | | strJson | string | 文件上傳用戶自定義參數(標準json字符串形式) | 否 | #### AnyChatUploadTask任務類簡介： | 方法 | 說明 | 返回參數 | | --- | --- | --- | | start( )| 開始傳輸 | void | | cancel( ) | 取消傳輸 | void | | getStatus( )| 主動查詢發送狀態 | AnyChatTaskState 對象 AnyChatTaskState.process 傳輸進度 (0.0-100.0) AnyChatTaskState.bitRate 傳輸碼率,單位為 bps AnyChatTaskState.status 1--準備; 2--傳輸中; 3--完成; 4--任務被取消 | #### AnyChatFileUploadEvent回調簡介： | 返回值 | 名稱 | 參數(類型):說明 | 接口說明 | 備注 | | --- | --- | --- | --- | --- | | void | onFileUploadDone | result(AnyChatResult) :執行結果 JsonData(object):返回數據 | 文件上傳成功通知事件 | result.code: 0表示成功，其他表示錯誤代號 result.msg: 錯誤描述 JsonData.FileName:文件名 JsonData.dwUserid: 用戶id,指示發送用戶 JsonData.TempFilePath:接收完成后，SDK 保存在本地的臨時文件（包含完整路徑） JsonData.dwFileLength:文件總長度 JsonData.dwTaskId:該文件所對應的任務編號 JsonData.taskId 任務ID| | void | OnTaskStatusChanged | JsonData(object):返回數據 |文件上傳過程狀態通知事件 |JsonData.taskId 任務ID JsonData.process 傳輸進度 (0.0-100.0) JsonData.bitRate 傳輸碼率,單位為 bps JsonData.status 1--準備; 2--傳輸中; 3--完成; 4--任務被取消 | #### 示例代碼： ``` //文件上傳配置類 let uploadOpt = new AnyChatFileUploadOpt(); //設置上傳文件的絕對路徑信息 uploadOpt.setLocalPath(filePath); //設置返回文件上傳狀態時間間隔，單位：s uploadOpt.setIntervalTime(1); //創建文件上傳任務 let uploadTask: AnyChatUploadTask = instance.createFileUploadTask(uploadOpt, { onFileUploadDone(result: AnyChatResult, json: object) { } onTaskStatusChanged(json: object) { } }); //開始上傳 uploadTask.start(); ```