实现视频通话

实时视频通话能够拉近人与人之间的距离，为用户提供沉浸式的交流体验，帮助你的 app 提高用户黏性。

本文介绍如何通过少量代码集成声网视频 SDK 并调用 API，在你的应用中实现高质量、低延迟的视频通话功能。

技术原理

下图展示在 app 中集成声网视频通话的基本工作流程：

如图所示，实现视频通话的步骤如下：

1. 获取 Token：当 app 客户端加入频道时，你需要使用 Token 验证用户身份。在测试或生产环境中，从 app 服务器中获取 Token。
2. 加入频道：调用 joinChannel 创建并加入频道。使用同一频道名称的 app 客户端默认加入同一频道。
3. 在频道内发布和订阅音视频流：加入频道后，app 客户端均可以在频道内发布和订阅音视频。

App 客户端加入频道需要以下信息：

• App ID：声网随机生成的字符串，用于识别你的 app，可从声网控制台获取。
• 用户 ID：用户的唯一标识。你需要自行设置用户 ID，并确保它在频道内是唯一的。
• Token：在测试或生产环境中，app 客户端从你的服务器中获取 Token。在本文介绍的流程中，你可以从声网控制台获取临时 Token。临时 Token 的有效期为 24 小时。
• 频道名称：用于标识视频通话频道的字符串。

前提条件

• Microsoft Visual Studio 2017 或以上版本
• Windows 7 或以上版本的设备
• 有效的声网账户（免费注册）
• 带有 App ID 和临时 Token 的声网项目。详情请参考开始使用声网平台。
• 可以访问互联网的计算机。如果你的网络环境部署了防火墙，请参考应用企业防火墙限制。

设置开发环境

本节介绍如何创建项目，并将声网视频 SDK 集成至你的项目中。

创建 Windows 项目

参考以下步骤创建一个 Windows 项目。若已有 Windows 项目，直接查看集成 SDK。

集成 SDK

根据你的 Windows Forms App 类型，选择对应的方式将 agora_rtc_sdk 添加到项目中。

• .net core 类型

  1. 在 Visual Studio 中创建 Windows Forms App .net core 应用程序。
  2. 添加 agora_rtc_sdk nuget 包引用。在 Solution Explorer 中右键 Dependencies，点击 Manage Nuget Packages > Browse，输入 agora_rtc_sdk，选择最新稳定版的 SDK，然后点击安装将 SDK 添加到项目中。

• .net framework 类型

  1. 在 Visual Studio 中创建 Windows Forms App .net framework 应用程序。
  2. 添加 agora_rtc_sdk nuget 包引用。在 Solution Explorer 中右键 References，点击 Manage Nuget Packages > Browse，输入 agora_rtc_sdk，选择最新稳定版的 SDK，然后点击安装将 SDK 添加到项目中。

实现视频通话

本节介绍如何实现视频通话。视频通话的 API 调用时序见下图：

1. 创建用户界面

根据场景需要，为你的项目创建视频通话的用户界面。若已有用户界面，可以直接查看使用域名。

如果你想实现一个视频通话，我们推荐你添加如下 UI 元素：

• 本地视频窗口
• 远端视频窗口
• 结束通话按钮

2. 引用 SDK

输入如下行引入声网 SDK：

using agora.rtc;

3. 派生事件回调

由于 C# 基于 C++ 封装，因此需要在代码中基于 IAgoraRtcEngineEventHandler 派生一个 AgoraRtcEventHandler 类，用来管理事件回调：

class AgoraRtcEventHandler : IAgoraRtcEngineEventHandler
{
      public AgoraRtcEventHandler()
      {

      }
};

4. 初始化 IAgoraRtcEngine

在调用其他声网 API 前，需要创建并初始化 IAgoraRtcEngine 对象。

调用 CreateAgoraRtcEngine 和 Initialize 方法，传入获取到的 App ID，即可初始化 IAgoraRtcEngine。

你还可以根据场景需要，在初始化时注册想要监听的回调事件，如注册用户加入频道和离开频道的回调。

// 声明变量
IAgoraRtcEngine rtc_engine_ = null;
IAgoraRtcEngineEventHandler event_handler_ = null;

if (null == rtc_engine_)
{
    // 创建 rtc engine
    rtc_engine_ = AgoraRtcEngine.CreateAgoraRtcEngine();
}

RtcEngineContext context = new RtcEngineContext(appId);
// 初始化 rtc engine
int ret = rtc_engine_.Initialize(context);
event_handler_ = new AgoraRtcEventHandler();

// 初始化事件回调
rtc_engine_.InitEventHandler(event_handler_);

// 开启视频
rtc_engine_.EnableVideo();

5. 设置本地视图

成功初始化 IAgoraRtcEngine 对象后，需要在加入频道前设置本地视图，以便在通话中看到本地图像。

VideoCanvas vs = new VideoCanvas((ulong)localWindowId.Handle, RENDER_MODE_TYPE.RENDER_MODE_FIT);
rtc_engine_.SetupLocalVideo(vs);

6. 加入频道

完成初始化和设置本地视图后，你就可以调用 JoinChannel 方法加入频道。你需要在该方法中传入如下参数：

• channelName: 传入能标识频道的频道 ID。输入频道 ID 相同的用户会进入同一个频道。

• token：传入用于鉴权的 Token，可设为如下一个值：

  • 临时 Token。你可以在控制台里生成一个临时 Token，详见获取临时 Token。加入频道时，请确保填入的频道名和生成临时 Token 时填入的频道名一致。
  • 在你的服务器端生成的 Token。在安全要求高的场景下，我们推荐你使用此种方式生成的 Token，详见从服务端生成 Token。加入频道时，请确保填入的频道名和 uid 与生成 Token 时填入的频道名和 uid 一致。
  • 若项目已启用 App 证书，请使用 Token。
  • 请勿将 token 设为 ""。

• uid: 本地用户的 ID。数据类型为整型，且频道内每个用户的 uid 必须是唯一的。若将 uid 设为 0，则 SDK 会自动分配一个 uid，并在 OnJoinChannelSuccess 回调中报告。
  用户成功加入频道后，会默认订阅频道内其他所有用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

rtc_engine_.JoinChannel("", "testChannelId","", 0, new ChannelMediaOptions(true, true, true, true));

7. 设置远端视图

视频通话中，通常你也需要看到其他用户。在加入频道后，可通过调用 SetupRemoteVideo 方法设置远端用户的视图。

远端用户成功加入频道后，SDK 会触发 OnUserJoined 回调，该回调中会包含这个远端用户的 uid 信息。在该回调中调用 SetupRemoteVideo 方法，传入获取到的 uid，设置远端用户的视图。

// 调用 SetupRemoteVideo 设置远端用户的视图。
VideoCanvas  vc = new VideoCanvas((ulong)remoteWindowId, 
RENDER_MODE_TYPE.RENDER_MODE_FIT, "testChannelId", remoteUid);
rtc_engine_.SetupRemoteVideo(vc);

8. 离开频道

根据场景需要，如结束通话、关闭 App 或 App 切换至后台时，调用 LeaveChannel 离开当前通话频道。

rtc_engine_.LeaveChannel();

编译并运行项目

编译生成应用程序后，将对应文件夹下的依赖库拷贝到运行目录下：

• 如果是 .netcore 64 位的 app，需要拷贝 netCore/x86_64 下所有的依赖库。
• 如果是 .netframework 32 位的 app，需要拷贝 netFramework/x86 下所有的依赖库。

你可以在 Windows 设备中运行此项目。当你成功开始视频通话时，你可以同时看到本地和远端的视频。

相关链接

示例项目

声网在 GitHub 上提供开源的实时视频通话示例项目 JoinChannelVideo。在实现相关功能前，你可以下载并查看源代码。

常见问题

• 如何设置日志文件？
• 如何处理视频黑屏问题？
• 如何在通话应用中实现呼叫邀请通知功能？