实现视频直播

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

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

技术原理

下图展示在 app 中集成声网极速直播的基本工作流程：

如图所示，实现极速直播的步骤如下：

1. 设置用户角色和延时级别：极速直播频道中，用户角色可以是主播或者观众。主播在频道内发布音视频流，观众可以订阅流。你可以利用 ClientRoleOptions 控制观众用户接收主播发布的音视频流的延时。
2. 获取 Token：当 app 客户端加入频道时，你需要使用 Token 验证用户身份。在测试或生产环境中，从 app 服务器中获取 Token。
3. 加入频道：调用 joinChannel 创建并加入频道。使用同一频道名称的 app 客户端默认加入同一频道。
4. 在频道内发布和订阅音视频流：加入频道后，角色为主播的 app 客户端可以发布音视频。如果观众想要发布音视频，可以调用 setClientRole 切换用户角色。

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。

创建 Windows 项目

1. 打开 Microsoft Visual Studio 并点击新建项目。
2. 进入新建项目窗口，选择项目类型为 MFC 应用程序，输入项目名称，选择项目存储路径，并点击确认。
3. 进入MFC 应用程序窗口，选择应用程序类型为基于对话框，并点击完成。

集成 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. 设置频道场景

初始化结束后，调用 SetChannelProfile 方法，将频道场景设为直播。

一个 IAgoraRtcEngine 只能使用一种频道场景。如果想切换为其他模式，需要先调用 Dispose 方法释放当前的 IAgoraRtcEngine 实例，然后调用 Initialize 方法创建一个新实例，再调用 SetChannelProfile 设置新的频道场景。

rtc_engine_.SetChannelProfile(CHANNEL_PROFILE_TYPE.CHANNEL_PROFILE_LIVE_BROADCASTING);

6. 设置用户角色和用户级别

直播频道中可设置用户角色和用户级别：

• 用户角色 (role) 确定用户在 SDK 层的权限，包含是否可以发流、是否可以收流等。直播频道有两种用户角色：主播和观众。主播既有发流权限，又有收流权限，而观众只有收流权限。默认的角色为观众。
• 用户级别 (level) 需要与用户角色结合使用，确定用户在其角色权限范围内可以操作和享受到的服务级别。例如对于观众，可以选择接收低延时还是超低延时的视频流。不同的级别会影响计费。

你可以在 app 中参考如下步骤设置用户角色：

1. 让终端用户选择自己的角色是主播还是观众。

2. 调用 SetClientRole 方法，然后根据终端用户的选择设置 role 和 options 参数。

   • 当 role 设为 CLIENT_ROLE_BROADCASTER（主播）时， options 参数留空。此时主播端延时为 < 400 ms。
   • 当 role 设为 CLIENT_ROLE_AUDIENCE（观众）时，你还需要将 options 中 audienceLatencyLevel 参数设为 AUDIENCE_LATENCY_LEVEL_LOW_LATENCY。此时观众端延时为 1500 ms - 2000 ms。

观众：

ClientRoleOptions role_options = new ClientRoleOptions();
role_options.audienceLatencyLevel = AUDIENCE_LATENCY_LEVEL_TYPE.AUDIENCE_LATENCY_LEVEL_LOW_LATENCY;
rtc_engine_.SetClientRole(CLIENT_ROLE_TYPE.CLIENT_ROLE_AUDIENCE, role_options); 

主播：

rtc_engine_.SetClientRole(CLIENT_ROLE_TYPE.CLIENT_ROLE_BROADCASTER);

7. 设置本地视图

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

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

8. 加入频道

完成设置角色和本地视图后，你就可以调用 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));

9. 设置远端视图

视频直播中，不论你是主播还是观众，都应该看到频道中的所有主播。在加入频道后，可通过调用 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);

10. 离开频道

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

rtc_engine_.LeaveChannel();

编译并运行项目

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

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

你可以在 Windows 设备中运行此项目。当成功开始视频直播时，主播可以看到自己的画面；观众可以看到主播的画面。

相关链接

示例项目

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

常见问题

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