文档概览/
RTC Engine/
SDK/
Windows/
集成/

集成

本文将介绍如何快速完成 Windows RTC Engine 的接入，实现一个基本的音视频通话。

环境准备

操作系统：Windows 7及以上版本。
开发环境：Visual Studio 2019及以上版本，推荐使用 Visual Studio 2022。

接入指引

步骤1. 导入 SDK

1. 打开 Visual Studio，新建一个您自己的 MFC 应用程序。在向导的 MFC Application 页面，Application type 选择 Dialog based，其他向导配置选择默认即可，单击 Finish。

2. 下载 Windows SDK，将解压后的 SDK 文件拷贝到.vcxproj 文件所在目录下。




步骤2. 配置项目

双击打开 .sln 工程文件，在右侧工具栏 Solution Explorer > 右键打开项目的选择菜单 > Properties，进行以下配置：
1. 添加 Additional Include Directories：
在 C/C++ > General > Additional Include Directories，添加 SDK 头文件目录：$(ProjectDir)SDK\CPlusPlus\Win64\include 和 $(ProjectDir)SDK\CPlusPlus\Win64\include\TRTC。

2. 添加 Additional Library Directories：
在 Linker > General > Additional Library Directories，添加 SDK 库目录$(ProjectDir)SDK\CPlusPlus\Win64\lib。



3. 添加 Additional Dependencies：
在 Linker > Input > Additional Dependencies，添加 SDK 库文件liteav.lib。



4. 添加 Command line：
在 Build Events > Post-Build Event > Command line，添加copy /Y $(ProjectDir)SDK\CPlusPlus\Win64\lib\*.dll $(OutDir)。



5. 打印 SDK 版本号：
5.1 双击打开 Solution Explorer 中的 .cpp 文件并引入 TRTC 头文件：
#include "ITRTCCloud.h"
注意：
在已有头文件的后面引用 "ITRTCCloud.h"，否则将会出现报错： ITRTCCloud：未定义标识符。
5.2 在 OnInitDialog 函数中，添加以下代码：
ITRTCCloud * pTRTCCloud = getTRTCShareInstance();
CString szText;
szText.Format(L"SDK version: %hs", pTRTCCloud->getSDKVersion());

CWnd *pStatic = GetDlgItem(IDC_STATIC);
pStatic->SetWindowTextW(szText);
5.3 完成以上步骤，单击 OK 成功打印 SDK 版本号即可。



说明：
如果出现报错信息：module machine type 'x86' conflicts with target machine type 'x64'，在解决方案平台选择 'x64'。

步骤3. 创建 TRTC 实例

1. 在 项目名.h 文件中引用头文件 "ITRTCCloud.h"，将该文件中的类公有继承于 CWinApp 和 ITRTCCloudCallback，并声明监听事件和 TRTCCloud 成员变量。
#include "ITRTCCloud.h" // 引入 TRTC 头文件

class CRTCWindowsApp: public CWinApp, public ITRTCCloudCallback
{
public:
	CRTCWindowsApp();

// Overrides
public:
	virtual BOOL InitInstance();
	virtual void onError(TXLiteAVError errCode, const char* errMsg, void* extraInfo) override; // 监听 'onError' 事件
	virtual void onWarning(TXLiteAVWarning warningCode, const char* warningMsg, void* extraInfo) override; // 监听 'onWarning' 事件
	virtual void onEnterRoom(int result) override; // 监听 'onEnterRoom' 事件
	virtual void onExitRoom(int reason) override; // 监听 'onExitRoom' 事件
 
    // 获取 TRTCCloud 实例
    static CRTCWindowsApp* GetInstance()
	{
		return static_cast<CRTCWindowsApp*>(AfxGetApp());
	}
 
// Implementation
	DECLARE_MESSAGE_MAP()

public:
	ITRTCCloud* trtc_cloud_; // 声明 TRTCCloud 成员变量
};
注意：
本文所创建的工程项目名为 RTCWindows，在整个接入的过程中，请替换为您自己项目的名称或类名。
2. 在 项目名.cpp 文件的 InitInstance 方法中调用 getTRTCShareInstance 初始化 TRTC 对象实例。
// 初始化 TRTCCloud 对象并添加事件监听
trtc_cloud_ = getTRTCShareInstance();
trtc_cloud_->addCallback(this);
说明：
建议将初始化 TRTC 对象实例的代码添加在 SetRegistryKey(_T("Local AppWizard-Generated Applications")) 方法后。
3. 实现声明的监听事件。
// 对监听事件进行处理
void CRTCWindowsApp::onError(TXLiteAVError errCode, const char* errMsg, void* extraInfo) {
    // 监听 "onError" 事件并对相应信息进行打印
}

void CRTCWindowsApp::onWarning(TXLiteAVWarning warningCode, const char* warningMsg, void* extraInfo) {
	// 监听 "onWarning" 事件并对相应信息进行打印
}

void CRTCWindowsApp::onEnterRoom(int result) { // 监听 "onEnterRoom" 事件并对相应信息进行打印
	if (result > 0) {
		MessageBox(NULL, TEXT("Enter room successfully"), TEXT("Notice"), MB_OK | MB_ICONINFORMATION); 
	}
	else {
		MessageBox(NULL, TEXT("Enter room failed"), TEXT("Notice"), MB_OK | MB_ICONINFORMATION); 
	}
}

void CRTCWindowsApp::onExitRoom(int reason) { // 监听 "onExitRoom" 事件并对相应信息进行打印
    if (reason == 0) {
        MessageBox(NULL, TEXT("Exit current room by calling the 'exitRoom' api of sdk"), TEXT("Notice"), MB_OK | MB_ICONINFORMATION); 
    } else if (reason == 1) {
        MessageBox(NULL, TEXT("Kicked out of the current room by server through the restful api"), TEXT("Notice"), MB_OK | MB_ICONINFORMATION); 
    } else if (reason == 2) {
        MessageBox(NULL, TEXT("The current room is dissolved by server through the restful api"), TEXT("Notice"), MB_OK | MB_ICONINFORMATION); 
    }
}

步骤4. 进入房间

设置进房参数 TRTCParams 并调用 enterRoom 即可成功进入房间，该方法通常在点击开始通话按钮后调用。
参数
类型
描述
sdkAppId
number
您在 TRTC 控制台中创建的音频和视频应用程序的sdkAppId。
userId
string
您指定的用户ID。
userSig
string
用户签名，请参见 UserSig 。
roomId
number
您指定的房间ID，通常是唯一的房间ID。
有关更详细的参数描述，请参考接口文档 enterRoom 。
void CRTCWindowsApp::OnBnClickedButton() {
    // 将以下 trtcParams 参数修改为自己的参数
    liteav::TRTCParams trtcParams;
    trtcParams.sdkAppId = 1400000123;
    trtcParams.userId = "denny"; 
    trtcParams.roomId = 123321;
    trtcParams.userSig = "xxx";

    // 对于多人视频通话场景，推荐使用 TRTC_APP_SCENE_LIVE
    ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
    trtcCloud->enterRoom(trtcParams, liteav::TRTCAppSceneLIVE);
}

步骤5. 打开/关闭摄像头

1. 在资源文件 IDD_TRTCDEMO_DIALOG 中，单击左侧边框的 Toolbox，拖动 Picture Control 到对话框中。
2. 在 Picture Control 控件的右键菜单中选择 Properties，ID 选择 AFX_IDC_PICTURE。
3. 在资源文件 IDD_TRTCDEMO_DIALOG 中添加一个 Button 组件，双击新建的 Button 后对 pLocalVideoView进行初始化，设置本地预览的渲染参数 setLocalRenderParams ，并调用startLocalPreview进行本地预览，成功调用enterRoom后开始推流。
void CRTCWindowsApp::OnBnClickedButton()
{
	// 设置本地预览渲染参数
	liteav::TRTCRenderParams render_params;
	render_params.mirrorType = liteav::TRTCVideoMirrorType_Enable;
	render_params.fillMode = TRTCVideoFillMode_Fill;
	ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
	trtcCloud->setLocalRenderParams(render_params);

	// 初始化 pLocalVideoView
	CWnd* pLocalVideoView = GetDlgItem(AFX_IDC_PICTURE);
	if (pLocalVideoView != nullptr) {
		auto local_view = (liteav::TXView)(pLocalVideoView->GetSafeHwnd());
        // 对采集内容进行本地预览 
		trtcCloud->startLocalPreview(local_view);
	}
}
调用stopLocalPreview关闭摄像头预览并停止推送本地视频信息。
void CRTCWindowsApp::OnBnClickedButton()
{
    TRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
    trtcCloud->stopLocalPreview();
}

步骤6. 打开/关闭麦克风

调用 startLocalAudio 开启麦克风采集，请根据您的需求选择以下其中一个声音质量参数Quality。
// 开启麦克风采集，设置当前场景为:语音模式
// 具有高的噪声抑制能力，有强有弱的网络阻力
ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
trtcCloud->startLocalAudio(TRTCAudioQualitySpeech);
// 开启麦克风采集，设置当前场景为:音乐模式
// 为获得高保真度，低音质损失，建议配合专业声卡使用
ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
trtcCloud->startLocalAudio(TRTCAudioQualityMusic);
调用stopLocalAudio关闭麦克风采集并停止推送本地音频信息。
ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
trtcCloud->stopLocalAudio();

步骤7. 播放/停止视频流

1. 在进入房间之前对 onUserVideoAvailable 进行监听，当您收到onUserVideoAvailable(userId, YES)通知时，表示该路画面已经有可播放的视频帧到达。
2. 调用startRemoteView/stopRemoteView选择播放或停止远端视频画面。
// 播放视频
CWnd* pLocalVideoView = GetDlgItem(AFX_IDC_PICTURE);
if (pLocalVideoView != nullptr) {
    auto local_view = (liteav::TXView)(pLocalVideoView->GetSafeHwnd());
    ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
    trtcCloud->startRemoteView("denny", liteav::TRTCVideoStreamTypeBig, video_view);
}
调用stopRemoteView 停止播放远端画面。
// 停止播放
ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
trtcCloud->stopRemoteView("denny", liteav::TRTCVideoStreamTypeBig); // 仅停止播放 denny 的视频
trtcCloud->stopAllRemoteView(); // 停止所有视频播放

步骤8. 播放/停止音频流

调用 muteRemoteAudio 选择播放或停止远端声音。
// 静音
ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
trtcCloud->muteRemoteAudio("denny", true); // 仅静音 denny

trtcCloud->muteAllRemoteAudio(true); // 静音所有远端用户
// 取消静音
ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
trtcCloud->muteRemoteAudio("denny", false); // 仅取消静音 denny

trtcCloud->muteAllRemoteAudio(false); // 取消静音所有远端用户

步骤9. 退出房间

在资源文件 IDD_TRTCDEMO_DIALOG 中添加一个 Button 组件，双击新建的 Button 后调用 exitRoom 退出当前的房间，TRTC SDK 会在退房结束后通过 onExitRoom 回调事件通知您。
void CRTCWindowsApp::OnBnClickedButton()
{
	ITRTCCloud* trtcCloud = CRTCWindowsApp::GetInstance()->trtc_cloud_;
    trtcCloud->exitRoom();
}

常见问题

您可以在 API 参考 查看所有函数列表及其描述。
如果您的接入和使用中遇到问题，请参见 常见问题。

联系我们

如果有任何需要或者反馈，您可以联系：info_rtc@tencent.com。