RTC SDK C++版开发指南

V3.0

1、修订记录

2、概述

RTC SDK提供人与人实时沟通协作过程中需要用到的所有基本能力，涵盖了网络会议系统、IM即时通讯系统及直播系统三大类终端产品音视频通讯的主要功能。

RTC SDK由业界资深工程师精心打造，稳定可靠，第三方团队拿来就能用，不必自己去造“轮子”，从而降低了第三方团队的技术风险，减少了项目的开发投入，尤其是能大幅缩短第三方团队开发具有多方音视频+数据协作能力的App/Web应用的时间。

RTC SDK可用于几乎所有行业，很多业务场景中需要用到人与人实时沟通与协作的能力，而类似QQ，微信或会议系统这种通用沟通工具又不能直接使用或不能满足功能，这种情况下，RTC SDK就是您最好的选择。市场调研表明，RTC SDK在医疗、教育、金融、能源、交通等各个领域，都有巨大的市场需求。

2.1、简介

RTC SDK 为移动、桌面和互联网应用提供一个完善的音视频及数据互动开发框架，屏蔽掉互动系统的复杂细节，对外提供较为简洁的 API 接口，方便第三方应用快速集成互动功能。

RTC SDK Android版提供如下功能：

• Android全平台支持
• 实时高清语音通话
• 实时高清视频通话

2.2、面向读者

本指南是提供给具有一定的 C++编程经验和了解面向对象概念的产品经理及程序员使用，Open-AVD SDK 已很好的封装了音视频相关的底层技术细节，因而读者不需要具备音视频开发方面的经验。

2.3、获取SDK Demo

公司的github网址(https://github.com/3tee)上会提供各类基于RTC SDK的实例 Demo，包括基本音视频能力Demo。

2.4、技术支持

您在使用本SDK的过程中，遇到任何困难，请与我们联系，我们将热忱为你提供帮助。你可以通过如下方式与我们取得联系。

Ø 技术支持工程师： 186XXXXXXXX

3 编写说明

本指南编写目的是为了帮助使用 AVD SDK 的用户快速搭建 SDK 的开发环境、熟悉开发流程、掌握 SDK 开发功能接口而编写的。 本指南基于 Visual Studio，导入 baseVideo Demo 进行最简单的音视频能力进行编写，如果需要更多的功能，请参阅 SDK API 接口开发手册。

4 环境准备

4.1 工程准备

4.1.1 开发工具 Visual Studio

本指南默认的开发工具为 Visual Studio 2017 ,它是微软推出的一款支持 C++的开发 IDE，运行以及修改 SDK Demo 非常方便。安装时选择插件如下图 4-1。

4.1.2 SDK Demo 工程导入

2.3 中下载的 SDK Demo，通过下面截图导入：

4.1.3 SDK Demo 工程运行

SDK Demo 导入工程后，于下图 4-4 处，将环境设置为 Release，再点击本地windows 调试器，即可很方便运行，截图如下：

4.2 非工程环境运行

5 音视频基本功能开发流程

本开发流程只涉及到音视频的基本功能，以 baseVideo Demo 的能力加以说明，关于其它的功能，如桌面共享、多摄像头的支持，可以参阅 SDK API 接口开发手册或咨询我们的技术支持工程师。

5.1 获取授权信息

针对正式客户及测试客户，公司会提供一对有效的 Access Key 和Secret Key，这对密钥可以产生访问令牌（24 小时有效），用于生成会议房间号，及加会房间等操作。目前 SDK Demo 提供的测试的授权信息及服务器地址如下，公司会不定期的更新，有问题请咨询。 服务器地址，依据当前 web 服务协议(http,https)指定对应的端口，默认是https

x
static rtc::String _url = "https://dev.3tee.cn:441";
static rtc::String _appkey = "SDKdemo_access";
static rtc::String _secretkey = "SDKdemo_secret";

通过调用 initSdkWithToken(),可以产生访问令牌，参考代码如下：

代码 5-2 产生访问令牌

xxxxxxxxxx
rtc::IAVDEngine::Instance()->uninit();
rtc::String server = _url;
Result result = rtc::IAVDEngine::Instance()->init(this, _url, _appkey, _secretkey);
if (result != AVD_OK){
AVD SDK C++端开发指南5
std::cout << "result = " << result << std::endl;
std::cout << "url = " << _url << std::endl;
return result;
}
Sleep(5000);
signal_initResult->emit(result);

5.2 引擎初始化

xxxxxxxxxx
rtc::IAVDEngine::Instance()->uninit();
rtc::String server = _url;
Result result = rtc::IAVDEngine::Instance()->init(this, _url, _appkey, _secretkey);
if (result != AVD_OK){
std::cout << "result = " << result << std::endl;
std::cout << "url = " << _url << std::endl;
return result;
}
Sleep(5000);
signal_initResult->emit(result);

5.3 获取房间

xxxxxxxxxx
_room = rtc::IRoom::obtain(roomId, userid);
if (!_room) {
std::cout << "error ,room " << roomId << " is null." << std::endl;
exit(-1);
}_room->setListener(this); _usermanager = rtc::IMUserManager::getUserManager(_room); _usermanager->setListener(this); _audio = rtc::IMAudio::getAudio(_room); _audiodevice = _audio->getAudioDevice(); _audio->setListener(this); _audiodevice->setListener(this);

xxxxxxxxxx
_video = rtc::IMVideo::getVideo(_room); 
_cameradevice = _video->getCameraDevice(); 
_video->setListener(this); 
_cameradevice->setListener(this);
return 0;

5.4 音视频

默认已打开音视频。

5.5 房间回调事件

xxxxxxxxxx
异步返回
/** 加入房间操作异步返回
*
* @param[in] result 加入错误代码。
* @return 0 成功
* Err_Stream_Connection_TimeOut 房间加会超时：可能原因有服务器没返回信令握手等
* Err_Rest_GetMcu_Failure 集群中获取可用mcu 失败；* Err_Net_ChannelSignal_Failure 房间信令连接失败，检查服务器地址和端口，及本地网络；
* Err_Net_ChannelData_Failure 房间数据连接失败（未实现）* @sa join
*/
virtual void onJoinResult(Result result) = 0;

5.6 用户回调事件

xxxxxxxxxx
** 摄像头视频发布通知
*
* @param[in] camera 摄像头信息，摄像头信息中 level 和description 为应用层数据，应用层可以使用这些字段保存次摄像头视频相关的应用逻辑数据，方便标示、订阅视频。*
* @note 当摄像头视频发布时，房间内所有用户接收到此通知；因通知的重要程
AVD SDK C++端开发指南7
度，将从 onCameraStatusNotify 中分离出此状态。
* @sa publishLocalCamera */
virtual void onPublishCameraNotify(const Camera& camera) = 0;
/** 摄像头视频取消发布通知
*
* @param[in] camera 摄像头信息。
*
* @note 当摄像头视频取消发布时，房间内所有用户接收到此通知；因通知的重要程度，将从 onCameraStatusNotify 中分离出此状态。
* @sa unpublishLocalCamera */
virtual void onUnpublishCameraNotify(const Camera& camera) = 0;
/** 本用户发布摄像头视频异步返回
*
* @param[in] result 错误代码。
* @param[in] fromId 摄像头 Id，唯一标示一路视频。
*
* @sa publishLocalCamera */
virtual void onPublishLocalResult(Result result, const DeviceId& fromId) = 0;
/** 本用户取消发布摄像头视频异步返回
*
* @param[in] result 错误代码。
* @param[in] fromId 摄像头 Id，唯一标示一路视频。
*
* @sa unpublishLocalCamera */
virtual void onUnpublishLocalResult(Result result, const DeviceId& fromId) = 0;

5.7 订阅/取消订阅视频

xxxxxxxxxx
/** 本用户订阅视频异步返回
*
* @param[in] result 错误代码。
* @param[in] fromId 摄像头 Id，唯一标示一路视频。
AVD SDK C++端开发指南8
*
* @sa subscribe */
virtual void onSubscribeResult(Result result, const DeviceId& fromId) = 0;

xxxxxxxxxx
/** 本用户取消订阅视频异步返回
*
* @param[in] result 错误代码。
* @param[in] fromId 摄像头 Id，唯一标示一路视频。
*
* @sa unsubscribe */
virtual void onUnsubscribeResult(Result result, const DeviceId& fromId) = 0;

5.8 音视频渲染

xxxxxxxxxx
avdroomwindow->_camera_self = avdroomwindow->_cameradevice->getDefaultCamera();
avdroomwindow->_selfVideoRender = avdroomwindow->GetSelfVideoRender();
avdroomwindow->_video->attachRender(avdroomwindow->_camera_self.id, avdroomwindow->_selfVideoRender);

6 附录

6.1 名词解释

7 错误码