### **初始化**
~~~
var instance = AnyChatWebSDK.sdkInit(initOpt);
~~~
**接口說明**
此接口方法內部實現sdk的初始化及登錄服務器兩個功能。
其中登錄有兩種模式:
1、密碼登錄:需傳入nickName和password 即可登錄,其中password可不傳;
2、簽名登錄:需傳入 nickName和sign(應用簽名),其他字段為可選 。
具體說明請查看登錄方式說明章節。
注:AnyChatWebSDK用于創建AnyChatWebSDK實例。
**返回值**
sdk實例
**接口參數簡介**
| 名稱 | 類型 | 說明 | 是否必須 |
| --- | --- | --- | --- |
| initOpt| object| SDK初始化配置類 | 是 |
**配置類簡介**
| 名稱 | 類型 | 說明 | 是否必須 |
| --- | --- | --- | --- |
|serverIp|string|服務器地址(IP地址或者域名)| 是 |
|serverPort|number|端口號| 是 |
|nickName|string|用戶賬號| 是 |
|password|string|用戶密碼| 否 |
|strUserId|string|用戶字符串Id| 否 |
|appId|string|應用ID(在AnyChat服務集群管理系統或云平臺新增應用ID)| 否(連接AnyChat服務集群非默認應用或云平臺時必傳)|
|sign|string|簽名字符串| 否(簽名登錄時必填)|
|timeStamp|string|時間戳| 否 |
|isMananger|number|動態綁定隊列坐席標識| 否(需要動態綁定隊列功能時必填) |
|isMonitor|number|無感監控坐席標識| 否 (需要無感監控功能時必填)|
|onDisConnect|function|鏈路斷開回調 | 是 |
|onLogin|function|登錄成功回調 | 是 |
|roomOpt|object|定義房間相關配置 | 否 |
|fileOpt|object|定義文件上傳/下載相關配置 | 否 |
|videoCallOpt|object|定義視頻呼叫相關配置 | 否 |
|logOpt|object|定義日志存儲相關配置(不設該配置項,則插件日志默認保存在插件安裝目錄下)| 否 |
|bufferOpt|object|定義透明通道相關配置 | 否 |
|cameraOpt|object|定義是否開啟虛擬攝像頭(該虛擬攝像頭用于桌面共享)| 否 |
|queueOpt|object|定義智能排隊相關配置| 否 |
兩種登錄方式所需參數請參考下一章節《登錄方式說明》
**回調說明**
| 名稱 | 參數說明 | 接口說明 | 備注 |
| --- | --- | --- | --- |
| onLogin | 登錄成功回調 |data(用戶信息)| data.userId 用戶userId|
|onDisconnect |連接斷開回調 |result(操作結果)|result.code 結果碼 <br> result.msg 結果描述<br>如果result.code為0則成功退出系統,否則連接出錯,原因可能有簽名錯誤,重復登錄,網絡異常斷開|
|onSessionKeep|會話保持回調 |result(操作結果)|result.message會話保持事件碼 <br> result.status會話保持狀態,0為網絡波動進入會話保持狀態,1為網絡狀態良好,退出會話保持狀態<br> result.userId會話保持事件用戶|
|onNetworkChange|網絡狀態回調 |result(操作結果)|result.code 網絡狀態事件碼 <br> result.msg網絡狀態改變描述|
|onAnyChatUDPAbnormal|UDP異常回調 |result(操作結果)|result.code UDP 異常事件碼 <br> result.msg UDP異常描述(注:該事件只在UDP異常的情況下觸發)|
|onDeviceInitFail|初始化設備異常回調 |result(操作結果)|result.code設備打開失敗事件碼 <br> result.devicetype失敗設備類型<br> result.msg打開失敗原因描述|
- SDK介紹
- 工程準備
- 獲取AnyChat Web SDK
- 安裝AnyChat Web插件
- 導入SDK文件
- 開發流程
- 初始化SDK
- 初始化以及自動登錄
- 登錄方式說明
- 版本信息查詢
- 退出以及釋放連接
- 回調事件注冊接口
- 回調事件解綁接口
- 房間管理
- 初始化
- 進入房間
- 獲取房間中的用戶列表
- 房間內的文字交流
- 退出房間
- 好友管理
- 初始化
- 獲取好友列表
- 獲取好友信息
- 獲取好友昵稱
- 獲取好友IP地址
- 音視頻操作
- 音視頻互動
- 本地麥克風管理
- 本地攝像頭管理
- 切換視頻設備
- 接收/終止對方音頻流
- 接收/終止對方視頻流
- 視頻呼叫
- 初始化
- 呼叫目標用戶
- 取消呼叫
- 接受呼叫
- 拒絕呼叫請求
- 掛斷
- 錄制(錄音錄像)
- 開始錄制
- 停止錄制
- 在錄像中添加水印
- 在錄像中插入圖片
- 更新錄像參數
- 取消錄像
- 視頻拍照
- 拍照
- 旋轉屏幕
- 本地文件瀏覽
- 噪音檢測
- 音頻工具箱
- 環境噪音查詢
- 麥克風靈敏度設置
- 獲取麥克風靈敏度
- 文件傳輸
- 初始化
- 發送文件
- 文件管理
- 上傳文件
- 下載文件
- 文件刪除
- 文件加密
- 文件解密
- 獲取磁盤空間
- 透明通道
- 初始化
- 發送透明通道消息
- 智能排隊
- 初始化
- 營業廳操作
- 獲取營業廳列表
- 進入營業廳
- 離開營業廳
- 隊列操作
- 進入隊列
- 取消排隊
- 坐席服務控制
- 狀態查詢
- 查詢坐席狀態
- 查詢隊列排隊人數
- 查詢排隊時長
- 查詢用戶所在隊列當前位置
- 查詢服務區域內排隊的用戶數
- 查詢營業廳內的坐席數
- 查詢隊列排隊用戶詳細信息
- 桌面共享與遠程協助
- 桌面共享
- 遠程協助
- 雙錄
- 流程介紹
- 臨柜雙錄
- 遠程雙錄
- 流程接口概述
- 雙錄接口說明
- PPT資源下載
- 下載任務初始化
- 開始下載
- 取消下載
- 查詢資源下載狀態
- PPT資源播放
- 初始化資源播放器
- 播放
- 暫停
- 停止
- 獲取當前播放信息
- 獲取PPT總頁碼,當前頁碼信息
- 資源切換到下一幀
- 資源切換到上一幀
- 媒體播放
- 創建媒體播放對象
- 設置播放位置
- 播放開始
- 播放暫停
- 播放停止
- 播放位置拖動
- 播放速度調整
- 循環播放設置
- 獲取播放信息
- 釋放媒體播放對象底層資源
- 時間戳
- 水印
- 虛擬背景
- 設置本地視頻虛擬背景
- SDK參數設置和查詢
- 設置SDK參數
- 查詢SDK參數
- 用戶相關的查詢接口
- 查詢用戶名
- 查詢用戶狀態
- 查詢用戶多媒體流參數
- AI功能模塊
- AI降噪
- AI虛擬背景
- AI美顏美妝
- 智能馬賽克
- 錯誤碼