修订历史（Revision history）
编号 修订内容描述 修订人 修订日期 修订后版本号 批准人
1
初稿
chenj 2015/6/03 1.00
2
整理补充 陈剑
2015/6/06
乐橙 SDK 文档说明-IOS 版本
1. 概述 ........................................................................................................................................ 3
2. 功能描述&重要概念 ............................................................................................................... 3
2.1 功能描述 ........................................................................................................................................ 3
2.2 重要概念 ........................................................................................................................................ 3
3.提供产物 ..................................................................................................................................... 5
4.开发指引 ..................................................................................................................................... 6
4.1 工程配置 ........................................................................................................................................ 6
4.2 接口初始化 .................................................................................................................................... 6
4.3 用户登陆 ........................................................................................................................................ 7
4.4 更新设备列表 ................................................................................................................................ 9
4.5 设备添加 ...................................................................................................................................... 11
4.6 实时预览 ...................................................................................................................................... 13
4.7 本地录像回放 .............................................................................................................................. 15
4.8 云录像回放 .................................................................................................................................. 18
4.9 语音对讲 ...................................................................................................................................... 20
4.10 RESTAPI 示例说明 ........................................................................................................................ 22
1. 概述
乐橙客户端 SDK 提供了一套使用乐橙设备以及乐橙平台的整体框架。通过该框架提供
的相关接口，客户端的上层应用程序可以实现在 Android，IOS 以及 Window 环境下添加乐橙
摄像头，获取乐橙摄像头码流，及回放远程摄像头 SD 卡，公有云服务器上的录像，同时支
持语音对讲，本地录像，抓图等功能。以下针对 IOS 平台做乐橙 SDK 功能的文档说明。
2. 功能描述&重要概念
2.1 功能描述
目前提供的 SDK 接口支持的功能点包括
1. 用户注册\登陆
2. 获取设备列表
3. 设备添加删除
4. 实时预览
5. TF 卡本地录像回放
6. 语音对讲
7. 云端录像回放
8. 手势缩放,移动
流转如下:
2.2 重要概念
用户登陆：
指客户端利用乐橙的 RestAPI 接口注册用户，并登陆乐橙平台服务器的过程。
PS：如果是注册，登陆第三方自己的平台，与平台的接口有区别。本文档以登陆乐橙平台为
例来描述如何实现实时预览，录像回放等相关功能。
更新设备列表：
指客户端用账号登陆后，可以通过相应接口，从平台获取摄像头列表清单，可以是本账号下
的绑定设备，也可以是注册未被添加的设备。
添加&删除设备：
添加设备指客户端通过乐橙 SDK 接口把某摄像头添加到账号下的过程。
删除设备指客户端通过乐橙 SDK 接口删除账号下摄像头设备的过程。
预览拉流
指在客户端（如手机）上获取设备的实时码流，并进行解码&显示的过程。
远程录像回放
指在客户端上获取设备 TF 卡上的文件流（录像），并进行解码&显示的过程。
云录像回放
指在客户端获取指定设备保存在云服务器上的文件流(录像), 并进行解码&显示的过程。
RestAPI
指客户端与乐橙平台交互的接口，Rest 风格。
播放组件
乐橙的播放模块，支持拉流，解码&显示，同时还对缩放、手势等操作等 UI 进行了封装。
通过播放组件，客户可以进行快速的开发集成代码，实现远程拉流，远程录像回放，本地录
像播放，抓图，UI 控制等相关功能。
3.提供产物
IOS 提供产物如下：
Jar 包名
接口
说明
libVideoComponent.a 播放接口
获取摄像头录像文件流与实时码流，并进行显示播放
获取云存储录像文件流，并进行显示播放
抓图
本地录像
云台控制
UI 显示&控制（手势缩放，翻页等）
libaudioTalk.a 语音对讲接口 双向语音对讲，支持回声消除
libHsviewClientSDK.a RestApi 接口 支持与平台服务对接
libTouProxy.a
libNATTraver.a
P2P 接口 支持 P2P 的方式与设备对接(获取实时流与文件流)
2） libVideoComponent.a，主要类为 PlayWindow，它是一个窗口控件，内置播放功能。
PlayWindow 实现了乐橙视频播放接口 IWindowComponent。
