文档中心
全部产品
Console 官网 社区 技术支持
简体中文
search-icon

实现视频直播

更新时间 2023/05/25 02:36:57

声网互动直播让你在 app 里轻松实现音视频直播功能，用户可以实时进行深入交流，创造更多商业机会。

本文介绍如何通过最简单的代码来集成声网视频 SDK，在你的 app 里实现高质量、低延时的音视频直播功能。

技术原理

下图展示了利用声网视频 SDK 来实现互动直播功能的工作流程。

参考以下步骤，在你的 app 中实现互动直播功能：

  1. 设置用户角色

    在互动直播中，用户角色可分为主播和观众。主播可在频道中发流，观众可接收频道中的音视频流。

  2. 加入频道

    调用 joinChannel 方法来创建并加入频道。在 App ID 一致的前提下，传入相同频道名的用户会进入同一个频道。

  3. 在频道中发布并接收音视频流

    加入频道后，主播可在频道中发流，并接收其他主播在频道中发布的音视频流。

  4. 在频道中接收音视频流

    观众只能接收主播在频道中发布的音视频流，你可以调用 setClientRole 将用户角色从观众切换为主播。

前提条件

  • Xcode 12.0 或以上版本。
  • 两台 iOS 9.0 或以上版本的设备。
  • 可以访问互联网的计算机。请确保你的网络环境未部署防火墙，否则可能无法正常使用声网服务。
  • 一个有效的声网账号以及声网项目。请参考开始使用声网平台从声网控制台获得以下信息：
    • App ID：声网随机生成的字符串，用于识别你的项目。
    • 临时 Token：Token 也称为动态密钥，在客户端加入频道时对用户鉴权。临时 token 的有效期为 24 小时。
    • 频道名：用于标识频道的字符串。
  • Apple 开发者账号。

创建项目

在 Xcode 中进行以下操作，在你的 app 中实现互动直播功能：

  1. 创建一个新的项目，Application 选择 App，Interface 选择 Storyboard，Language 选择 Swift。

    如果你没有添加过开发团队信息，会看到 Add account… 按钮。点击该按钮并按照屏幕提示登入 Apple ID，点击 Next，完成后即可选择你的 Apple 账户作为开发团队。

  2. 为你的项目设置自动签名。

  3. 设置部署你的 app 的目标设备。

  4. 添加项目的设备权限。

    在项目导航栏中打开 info.plist 文件，编辑属性列表，添加以下属性：

    key type value
    Privacy - Microphone Usage Description String 使用麦克风的目的，例如：for a call or live interactive streaming。
    Privacy - Camera Usage Description String 使用摄像头的目的，例如：for a call or live interactive streaming。
    • 如果你的项目中需要添加第三方插件或库（例如第三方摄像头），且该插件或库的签名与项目的签名不一致，你还需勾选 Hardened Runtime > Runtime Exceptions 中的 Disable Library Validation。
    • 更多注意事项，可以参考 Preparing Your App for Distribution。

  5. 将声网视频 SDK 集成到你的项目。

    开始前请确保你已安装 Cocoapods，如尚未安装 Cocoapods，参考 Getting Started with CocoaPods 安装说明。

    1. 在终端里进入项目根目录，并运行 pod init 命令。项目文件夹下会生成一个 Podfile 文本文件。
    2. 打开 Podfile 文件，修改文件为如下内容。注意将 Your App 替换为你的 Target 名称。
    platform :ios, '9.0'
target 'Your App' do
# x.y.z 请填写具体的 SDK 版本号，如 4.0.1 或 4.0.0.4。
# 可通过发版说明获取最新版本号。
pod 'AgoraRtcEngine_iOS', 'x.y.z'
end

    1. 在终端内运行 pod install 命令安装声网 SDK。成功安装后，Terminal 中会显示 Pod installation complete!。

    2. 成功安装后，项目文件夹下会生成一个后缀为 .xcworkspace 的文件，通过 Xcode 打开该文件进行后续操作。

    你也可以使用其他方式来集成 SDK，详见其他集成方式。

实现互动直播

本节介绍如何使用声网视频 SDK 在你的 app 中实现互动直播功能。

创建用户界面

为互动直播功能创建基本的用户界面时，声网推荐你在项目中添加主播的视频窗口。参考以下代码创建一个基础的用户界面：

import UIKit
class ViewController: UIViewController{
    ...
    // 定义 localView 变量
    var localView: UIView!
    // 定义 remoteView 变量
    var remoteView: UIView!
    // 定义 agoraKit
    var agoraKit: AgoraRtcEngineKit!

    // 设置视频窗口布局
    override func viewDidLayoutSubviews(){
        super.viewDidLayoutSubviews()
        remoteView.frame = self.view.bounds
        localView.frame = CGRect(x: self.view.bounds.width - 90, y: 0, width: 90, height: 160)
    }

    func initView(){
        // 初始化远端视频窗口。只有当远端用户为主播时，才会显示视频画面
        remoteView = UIView()
        self.view.addSubview(remoteView)
        // 初始化本地视频窗口。只有当本地用户为主播时，才会显示视频画面
        localView = UIView()
        self.view.addSubview(localView)
    }
}

实现互动直播逻辑

下图展示了实现互动直播的 API 调用时序。

参考以下步骤来实现互动直播逻辑：

  1. 导入声网kit

    打开 ViewController.swift 文件，将下列代码添加至 import UIKit 之后：

    import AgoraRtcKit

  2. 初始化声网引擎

    一个 AgoraRtcEngineKit 对象只支持一个频道场景。如果你想切换频道场景，调用 destroy 来释放当前的 AgoraRtcEngineKit 对象，再调用 sharedEngineWithConfig 创建一个新的 AgoraRtcEngineKit 对象。

    在 ViewController.swift 文件中，将下列代码添加至 initView 之后：

    func initializeAgoraEngine(){
    let config = AgoraRtcEngineConfig()
    // 在这里输入你的 App ID.
    config.appId = <#Your app Id#>
    // 调用 AgoraRtcEngineDelegate
    agoraKit = AgoraRtcEngineKit.sharedEngine(with: config, delegate: self)
}

  3. 启用视频模块

    在 ViewController.swift 文件，将下列代码添加至 initializeAgoraEngine 之后：

    func setupLocalVideo(){
    // 启用视频模块
    agoraKit?.enableVideo()
    // 开始本地预览
    agoraKit?.startPreview()
    let videoCanvas = AgoraRtcVideoCanvas()
    videoCanvas.uid = 0
    videoCanvas.renderMode = .hidden
    videoCanvas.view = localView
    // 设置本地视图
    agoraKit?.setupLocalVideo(videoCanvas)
}

  4. 填入你的临时 token、频道名以及用户 ID 加入频道并设置频道场景及用户角色

    在 ViewController.swift 文件中，将下列代码添加至 setupLocalVideo 之后：

    func joinChannel(){
    let option = AgoraRtcChannelMediaOptions()
    // 在视频直播场景下，将频道场景设置为 liveBroadcasting
    option.channelProfile = .of((Int32)(AgoraChannelProfile.liveBroadcasting.rawValue))
    // 设置用户角色为主播或观众
    option.clientRoleType = .of((Int32)(AgoraClientRole.broadcaster.rawValue))

    // 使用临时 token 加入频道，在这里传入你的项目的 token 和频道名。
    agoraKit?.joinChannel(byToken: <#Your token#>, channelId: <#Your channel name#>, uid: 0, mediaOptions: option)
}

  5. 设置远端用户视图

    在 ViewController.swift 文件中，将以下代码添加至 ViewController 类之后：

    extension ViewController: AgoraRtcEngineDelegate{
    func rtcEngine(_ engine: AgoraRtcEngineKit, didJoinedOfUid uid: UInt, elapsed: Int){
        let videoCanvas = AgoraRtcVideoCanvas()
        videoCanvas.uid = uid
        videoCanvas.renderMode = .hidden
        videoCanvas.view = remoteView
        agoraKit?.setupRemoteVideo(videoCanvas)
    }
}

启动和关闭 app

至此，你已经成功在你的 app 中添加了互动直播功能。当用户启动你的 app 时，互动直播开始；当用户关闭 app 时，互动直播结束。

  1. 当视图加载完成后，调用 viewDidLoad 加入频道。

    打开 ViewController.swift 文件，将 viewDidLoad 添加至 UIViewController 中：

    override func viewDidLoad() {
    super.viewDidLoad()
    // 当加载视图后，你可以进行其他设置。
    // 初始化视频窗口
    initView()
    // 当调用声网 API 时，以下函数会被调用
    initializeAgoraEngine()
    setupLocalVideo()
    joinChannel()
}

  2. 离开频道以清理所有会话相关的资源。

    在 ViewController.swift 文件中，添加如下代码。

    如果你想释放声网 SDK 使用的所有资源，需调用 destroy 清理你在 initializeAgoraEngine 函数中创建的所有资源。
        agoraKit?.stopPreview()
    agoraKit?.leaveChannel(nil)

测试你的 app

参考以下步骤来测试你的 app：

  1. 将 iOS 设备连接至计算机。

  2. 点击 Build 来运行你的项目，需等待几秒至安装完成。

  3. 允许 app 访问设备的麦克风和摄像头权限。

  4. 当 app 启动后，如果你将用户角色设为主播，则可以在本地视频窗口中看到自己。

  5. 邀请一位朋友通过另一台设备来使用相同的 App ID、Token、频道名加入频道。如果你的朋友以主播身份加入，你们可以听见、看见对方；如果作为观众加入，你只能看到自己，你的朋友可以看到你并听到你的声音。

后续步骤

在测试或生产环境中，为确保通信安全，声网推荐使用 token 服务器来生成 token，详见使用 Token 鉴权。

相关信息

本节提供了额外的信息供参考。

示例项目

声网在 Github 上提供一个开源的互动直播示例项目 JoinChannelVideo 供你参考。

其他集成方式

手动集成 SDK

  1. 前往 SDK 下载页面，获取最新版的 iOS 视频 SDK，然后解压。

  2. 将 SDK 包内 libs 路径下的文件，拷贝到你的项目路径下。

  3. 打开 Xcode，添加对应动态库，确保添加的动态库 Embed 属性设置为 Embed & Sign。

    • 根据 Apple 官方要求，app 的 Extension 中不允许包含动态库。如果项目中的 Extension 需要集成 SDK，则添加动态库时需将文件状态改为 Do Not Embed。
    • 声网 SDK 默认使用 libc++ (LLVM)，如需使用 libstdc++ (GNU)，请联系 sales@shengwang.cn。SDK 提供的库是 FAT Image，包含 32/64 位模拟器、32/64 位真机版本。

使用 Swift Package Manager

  1. 在 Xcode 中，进入 File > Swift Packages > Add Package Dependencies...，粘贴如下 URL：

    https://github.com/AgoraIO/AgoraRtcEngine_iOS.git

  2. 在 Choose Package Options 中指定你想集成的 SDK 版本。你也可以参考 Apple 官方文档进行设置。

监听观众角色用户事件

在直播频道中，声网视频 SDK 不会报告角色设为观众的用户事件。如有此需求，请参考直播场景下，如何监听远端观众角色用户加入/离开频道的事件。