Vidyo视频产品-嵌入视频API开发平台

1. Vidyo Client API

Vidyo Client API 分为 2 大类：

   1) 桌面客户端：windows OS、Mac OSX 以及Linux；

   2) 移动客户端：iOS and Android；

Client API 可以帮助用户实现以下功能：

   1) 开发自己的视频应用终端，并将视频通讯功能集成到自己的APP 中；

   2) 支持Vidyo 视频通讯窗口嵌入在APP 中；

   3) 支持客户端程序对视频通讯的属性进行定制，包括视频通话、会议参会方的窗口大小、布局；终端配置管理等；

   4) 支持Vidyo 的终端标准功能，包括：

         a) 初试化上线、启动；

         b) 下线、停止；

         c) 从APP 端发送Request 到Vidyo Lib 库；

         d) 发送Event 到Vidyo Lib 库；

         e) 获取Event 从Vidyo lib 库到APP；

Vidyo client API开发包

Vidyo client API 为用户提供了完成开发包，工程师可以基于开发包开发完整的视频应用客户端软件，主要包含以下：

    3) Binary library 二进制库

    4) Header files 头文件

    5) Sample code 例子代码

    6) Reference guide 参考文档

    7) Demo APP 例子应用APP

2. Vidyo Web Service API

      Vidyo 视频通讯平台提供了最先进的，基于互联网的视频会议技术。Web Service API 是由Vidyo Portal 提供的API，用户可以依据Vidyo 提供的技术开发自己视频应用。Web Service API都是基于XML 的soap 请求，基于HTTP 或HTTPS。

为了方便用户对这些功能的了解，我们将 Web Service API 分为以下几类：

      1) Guest API

Guest API-一组用于通过Web Service API 来开发访客用户功能的API。 Vidyo Portal Guest API 的概念是允许临时用户登录，临时链接到端点客户端并加入会议。 Vidyo Portal Guest 离开会议后，这些访客用户将被自动删除。现在Vidyo Guest 用户API 通常我们已不再使用，client API 已提供了Guest API 的封装实现，可以通过Client API 直接调用。

         Guest API 主要实现的功能

         a) 未注册的用户，在Vidyo 平台内的未授权用户，登录平台并加入到一个视频会议中，这些参会者不需要事先在Vidyo 系统中创建账户：

         b) 允许Guest 登录；

         c) 为Guest 用户指定一个终端(客户开发的APP、Vidyo Desktop、Vidyo Mobile)

         d) 允许Guest 加入一个私人的或者公共的会议室；

      2) User API

User API - 用于开发针对最终用户的第三方端点或应用程序的一组API，提供搜索，加入会议室，直接呼叫，控制会议室，记录Vidyo 呼叫，邀请用户等功能。

User API主要实现的功能

         a) 允许注册用户，在Vidyo 平台已授权的用户，登录平台，并且使用所有Vidyo 用户可以使用的功能，包括：

         b) 登录；

         c) 加入会议、发起P2P 的视频呼叫、预定会议室资源；

         d) 会管功能：锁定会议室，获取参会者的名单，mute/unmute，将某个参会者踢出会议；

         e) 会议室PIN 管理；

         f) 搜索用户；

         g) 视频会议录像：启动视频录像，附件管理，搜寻录像库，更新、删除录像库；

         h) 推送或者获取用户状态信息；

         i) 使用SOAP 向第三方系统认证；

      3) Admin API

Admin API - 用于管理成员，会议室，网关等的一组管理API。这些API 仅限具有“admin”或“operator”权限的授权用户使用。这些API 可用于开发“管理”工具。

Admin API主要实现的功能

         a) 用来执行后台应用，例如用户、会议室、组管理：

         b) 对平台内账户、会议室、组进行增加、更新、删除的操作；

         c) 管理员级别的对会议管理：锁定会议室，获取参会方的名单，mute/unmute，踢出某个参会方；

         d) 视频会议录像：启动视频录像，附件管理，搜寻录像库，更新、删除录像库

Super Admin API：

         a) 一组超级管理员API 来创建租户，确实在系统中创建逻辑分离。此API 还用于管理其他Vidyo 组件，如Vidyo Manager 和Vidyo Gateways

         b) 获取租户信息、租户前缀（用于视频呼叫前缀）

Vidyo API开放平台，集成接口

       Vidyo API 软件包使得客户将Vidyo 的视频会议的声音，视频，数据共享集成到客户自己的已有应用程序里面，更加符合客户的使用习惯，无需在不同的程序之间不停跳转。 如果客户想把视频会议功能加入到现有的应用程序或者Web Portal， 或者想定制开发一个终端，那么采用Vidyo 提供的API 是一个简单便捷的方法。 这些 API 提供很多服务，比如资源管理，客户状态机的管理，回声消除等等功能。以下是API 的框架图。