AnyChat视频云平台开发指南

佰锐科技-刘冬明

简介：   

          AnyChat视频云平台提供线上的音视频通信、多应用接入、即时通讯、全景录像、智能排队，直播、点播等服务。为您定制个性化、多领域公有云、私有云、专有云视频云服务。

根据您自身的业务需求，按需选择视频云服务构建自己的视频云应用。（点击立即登录视频云平台）

         云平台开发流程为获取SDK，导入SDK，设置监听事件，初始化SDK，登录云平台以及音视频交互。本文是AnyChat SDK开发流程的一个简单概述，详细的开发流程以及API接口，请参考SDK包中的《AnyChat SDK开发手册》，《AnyChat SDK开发流程指南》等文档。另外云平台为商户提供了丰富的业务服务功能，详情请参见业务服务开发指南 。

温馨提示：为了获得更好的用户体验、更好的性能以及更加全面的功能，请适时更新SDK。



  获取AnyChat SDK

AnyChat视频云提供了多种平台下的SDK开发包，下载网址为：http://sdk.anychat.cn/html/download.html。SDK包里面提供了可执行程序、动态库、开发接口文档、程序开发接口、开发示例代码，其解压之后的目录结构如下 所示：

|------bin      AnyChat SDK动态库、演示程序
|
|------doc     开发文档
|
|------src       演示程序源代码
|
|-------sdk       SDK接口引用文件



  导入AnyChat SDK

将AnyChat SDK动态库以及接口引用文件导入到开发工程中，导入文件和导入过程与用户所选择的SDK平台有关，具体请参见SDK包中的开发流程指南。

  设置监听基本事件

SDK许多API调用都是对网络或者硬件的异步操作，这些异步调用的结果会以回调事件来通知应用层，可以实现监听“连接服务器、用户登录、进入房间、进入队列、视频呼叫、视频通话”等事件。

  初始化SDK

   加载资源，应用程序中只需要执行一次，其他的功能接口都必须在初始化之后才能正常使用。

  登录云平台

1、云平台登录方式
云平台支持两种应用登录方式：

  1)、签名登录：应用终端客户接入云平台时，需要向用户自己部署的身份验证系统获取签名，签名由应用的私钥生成，云平台使用应用公钥认证签名，并根据认证结果决定是否让应用终端接入。

  2)、普通登录：应用终端接入的身份认证由应用的业务服务器来完成，云平台根据业务服务器的认证结果决定是否让应用终端接入。


云平台默认两种登录方式都支持，方式一采用更加安全的签名算法，推荐使用。 方式二能让线下用户很方便的迁移到云平台。

签名登录过程如下图所示：



2、登录AnyChat视频云平台

AnyChat视频云平台支持多个云应用的接入。接入需要使用appGuId，appGuId为用户在AnyChat视频云平台创建的应用的唯一标识。

1)、普通登录

需要调用“BRAC_SetSDKOption”接口设置连接的应用Id。代码如下：

我们云平台对外公开的服务器地址为cloud.anychat.cn，端口号为8906。

连接视频云平台服务器、登录服务器接口调用代码如下所示：

2)、签名登录

在调用BRAC_LoginEx接口之前需要先进行应用签名。

应用签名的生成请参考以下示例程序:

语言	下载包
Java	<<AnyChatSignDemo.rar>>
PHP	<<AnyChatSignDemoForPHP.rar>>
Nodejs	<<AnyChatSignDemoForNodejs.rar>>

  音视频交互

AnyChat for Web SDK为开发者提供了便捷的建立音视频通讯的接口，通过以下几步操作，即可在您的应用中集成音视频交互功能。需要注意的是只有在同一个房间内的用户才能进行音视频通讯。

1、打开本地音视频

打开本地/远程音视频数据需要在进入房间成功之后才有效，这里是列举了打开远程视频的方法，参考代码如下：

2、关闭本地音视频

打开本地音视频后，可以在音视频交互的过程中选择关闭本地音视频。同时，还可以在关闭之后重新打开本地音视频；在音视频交互结束之后需要调用该操作，释放本地摄像头和音频采集设备，参考代码如下：

3、请求远程音视频

在通话目标对象已经进入当前房间之后，该操作才有效。

4、关闭远程音视频

请求远程音视频后，可以在音视频交互的过程中选择关闭远程音视频。同时，还可以在关闭之后重新请求远程音视频；在音视频交互结束之后需要调用该操作，释放远程音视频资源，参考代码如下：

  业务服务开发指南

1、业务服务功能概述

商户后台可通过http协议实现与云平台的业务服务对接，云平台提供了丰富的业务服务功能：

1)、登录、注册、录像、服务端拍照、坐席状态变化、文件传输完成、视频呼叫、文字聊天数据等回调通知；

2)、用户信息、营业厅、队列、技能组等数据查询功能；

3)、营业厅、队列、技能组等设置功能以及用户信息控制功能；

4)、透明通道传输功能

5)、检索文件列表、获取文件信息、文件信息控制等功能；

其中营业厅、队列、技能组的配置也可以直接在云平台应用详情页面进行配置，用户可在应用列表点击详情按钮进入配置页面。配置内容如下:

另外文件检索、播放、下载等操作也可以直接在云平台应用存储空间页面进行操作，用户可在应用列表点击"更多"按钮，在下拉菜单中选择"存储空间"进入页面。操作界面如下:

2、业务服务对接步骤

1)、设置业务服务签名密钥，用于业务服务交互的签名校验；

2)、设置商户业务服务回调通知入口地址，商户后台需确保该服务地址可用，云平台回调通知将发往该地址；

3)、选择商户后台需要接收的回调事件类型；

4)、下载业务服务开发接口文档以及示例程序进行对接

其中步骤1)，2)，3)在云平台应用详情页面中配置，用户可在应用列表点击详情按钮进入配置页面。配置内容如下:

3、业务服务接口说明文档与示例程序

1)、点击以下链接下载业务服务接口说明文档；

<<业务服务接口说明文档.docx>>

2)、点击以下链接下载业务服务接口SDK；

<<AnyChatBusinessServiceSdk.rar>>

3)、点击以下链接下载业务服务接口示例程序；

<<AnyChatBusinessServiceDemo.rar>>