### **初始化**
sdkInit(initOpt: AnyChatInitOpt): AnyChatSDK
#### 接口说明:
此接口方法内部实现sdk的初始化及登录服务器两个功能.
其中登录有两种模式,
1、密码登录:需传入nickName和password 即可登录,其中password可不传;
2、签名登录:需传入 nickName和sign、appId、timestamp,其他字段为可选 。
登录方式详述可参考"登录方式说明"章节
#### 返回值:
sdk单例,一个客户端对象,后续各类模块API操作,修改配置、注册模块事件都针对该对象。
#### 接口参数简介:
| 名称 | 类型 | 说明 | 是否必须 |
| --- | --- | --- | --- |
| initOpt| AnyChatInitOpt| SDK初始化配置类 | 是 |
#### AnyChatInitOpt 配置类简介:
#### 通用属性
| 名称 | 类型 | 说明 | 是否必须 |
| --- | --- | --- | --- |
| serverIp | string | 服务器地址(IP地址或域名) ,AnyChat服务器地址(demo.anychat.cn),如连接云平台,地址为cloud.anychat.cn | 是 |
| serverPort | number | 服务器通信端口,AnyChat服务器端口号:8906 | 是 |
| nickName | string |用户昵称 | 是 |
| LoginEvent | AnyChatLoginEvent | 登录状态回调 | 是 |
#### 使用普通登录需要注意的属性
| 名称 | 类型 | 说明 | 是否必须 |
| --- | --- | --- | --- |
| password | string |密码 | 否 |
#### 使用签名登录时需要注意的属性
| 名称 | 类型 | 说明 | 是否必须 |
| --- | --- | --- | --- |
| appId | string | 应用id | 否 |
| sign | string | 应用签名 | 否 |
| timeStamp | number | 时间戳 | 否 |
| strUserId |string|业务系统用户身份唯一标识,普通登录该参数无效|否|
#### AnyChatLoginEvent回调简介:
| 返回值 | 名称 | 参数(类型)说明 | 接口说明 | 备注 |
| --- | --- | --- | --- | --- |
| void | onLogin | userId(number)|登录成功 | 登录用户Id |
|void |onDisconnect |result(AnyChatResult) |连接断开|原因可能有签名错误,重复登录,网络异常断开... |
#### 示例代码:
```
// anychatSDK is the instance of sdk
let initOpt: AnyChatInitOpt = new AnyChatInitOpt( nickName, strUserId, password, serverIp, serverPort, loginEvent)
anychatSDK.sdkInit(initOpt);//初始化
```
- SDK介绍
- 工程准备
- 获取AnyChatHarmonySDK
- 导入SDK文件
- 混淆加固
- 开发流程
- 初始化SDK
- 初始化及自动登录
- 退出及释放连接
- 版本信息查询
- 登录方式说明
- 服务器连接断开通知事件
- 会话保持注册和销毁事件
- 房间管理
- 注册房间管理事件
- 注销房间管理事件
- 进入房间
- 获取房间中的用户列表
- 房间内的文字交流
- 退出房间
- 音视频操作
- 音视频互动
- 本地麦克风管理
- 打开本地麦克风
- 关闭本地麦克风
- 本地摄像头管理
- 打开本地摄像头
- 关闭本地摄像头
- 切换本地摄像头
- 接收/终止对方音频流
- 接收远程音频流
- 关闭远程音频流
- 接收/终止对方视频流
- 获取远程视频流
- 关闭远程视频流
- 视频呼叫
- 注册视频呼叫事件
- 客户呼叫
- 客户取消呼叫
- 接听视频呼叫
- 拒绝接听
- 挂断通话
- 注销视频呼叫事件
- 录制(录音录像)
- 开始录制
- 在录制文件中添加图片水印
- 在录制文件中添加文字水印
- 在录像中插入图片
- 更新录像参数
- 结束录制
- 视频拍照
- 抓拍
- 音视频参数配置
- 视频参数配置
- 音频参数配置
- 文件传输
- 初始化文件模块
- 注册文件接收通知事件
- 注销文件接收通知事件
- 创建文件传输任务
- 文件管理
- 初始化文件模块
- 创建文件上传任务
- 创建文件下载任务
- 透明通道
- 发送透明通道
- 注册接收透明通道通知事件
- 注销接收透明通道通知事件
- 智能排队
- 初始化排队模块
- 营业厅操作
- 获取营业厅列表
- 进入营业厅
- 席座服务状态设置
- 离开营业厅
- 排队操作
- 进入队列
- 取消排队
- 状态查询
- 查询坐席状态
- 查询队伍排队人数
- 查询当前排队时间
- 查询用户所在队列的当前位置
- 查询服务区域内排队的用户数
- 查询营业厅内的坐席数
- 注册队列状态变化事件的监听
- 注销队列状态变化事件的监听
- 屏幕共享
- 双录
- 基本流程
- 自助双录
- 远程双录
- 双录接口说明
- PPT资源下载
- 下载任务初始化
- 开始下载
- 取消下载
- 查询资源下载状态
- 查询资源详细信息
- 资源播放
- 媒体资源播放
- 播放
- 暂停
- 停止
- 销毁
- 获取当前播放信息
- 播放状态回调接口
- 时间戳
- 水印
- 用户相关的查询接口
- 查询用户名
- 错误码
