### **初始化**
~~~
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美颜美妆
- 智能马赛克
- 错误码
