写点什么

基于 Agora SDK 实现 macOS 端的一对一视频通话

  • 2020-02-25
  • 本文字数:4263 字

    阅读完需:约 14 分钟

基于 Agora SDK 实现 macOS 端的一对一视频通话

本文介绍基于 Agora SDK 在 macOS 端实现一对一视频通话。

前提条件

  • Xcode 9.0 或以上版本

  • 支持 macOS 10.10 或以上版本的 macOS 设备

  • 有效的 Agora 账户(免费注册)

  • 注:如果你的网络环境部署了防火墙,请根据声网文档中心的「应用企业防火墙限制」打开相关端口。

准备开发环境

本节介绍如何创建项目,并将 Agora SDK 集成至你的项目中。

创建 macOS 项目

参考以下步骤创建一个 macOS 项目。若已有 macOS 项目,可以跳脱这一步,直接查看本文「集成 SDK」小节。


  1. 打开 Xcode 并点击 Create a new Xcode project。

  2. 选择项目类型为 Cocoa App,并点击 Next。

  3. 输入项目信息,如项目名称、开发团队信息、组织名称和语言,并点击 Next。

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

  5. 选择项目存储路径,并点击 Create。

  6. 进入 TARGETS > Project Name > General > Signing 菜单,选择 Automatically manage signing,并在弹出菜单中点击 Enable Automatic。

集成 SDK

选择如下任意一种方式将 Agora SDK 集成到你的项目中。

方法一:使用 CocoaPods 自动集成

  1. 开始前确保你已安装 Cocoapods。参考 Getting Started with CocoaPods 安装说明。

  2. 在 Terminal 里进入项目根目录,并运行 pod init 命令。项目文件夹下会生成一个 Podfile 文本文件。

  3. 打开 Podfile 文件,修改文件为如下内容。注意将 Your App 替换为你的 Target 名称。

platform :macOS, ‘10.11’ use_frameworks!

target ‘Your App’ do


pod ‘AgoraRtcEngine_macOS’


end


4. 在 Terminal 内运行 pod update 命令更新本地库版本。


5. 运行 pod install 命令安装 Agora SDK。成功安装后,Terminal 中会显示 Pod installation complete!,此时项目文件夹下会生成一个 xcworkspace 文件。


6. 打开新生成的 xcworkspace 文件。

方法二:手动复制 SDK 文件

  1. 前往 SDK 下载页面,获取最新版的 Agora SDK,然后解压。

  2. 将 libs 文件夹内的 AgoraRtcEngineKit.framework 文件复制到项目文件夹下。

  3. 打开 Xcode,进入 TARGETS > Project Name > Build Phases > Link Binary with Libraries 菜单,点击 + 添加如下库。在添加 AgoraRtcEngineKit.framework 文件时,还需在点击 + 后点击 Add Other…,找到本地文件并打开。

  4. 添加前:

  5. 添加后:


  • AgoraRtcEngineKit.framework

  • Accelerate.framework

  • CoreWLAN.framework

  • libc++.dylib

  • libresolv.9.tbd

  • SystemConfiguration.framework

  • VideoToolbox.framework

添加媒体设备权限

  1. 根据场景需要,打开 Xcode ,在 info.plist 文件中,点击 + 图标开始添加如下内容,获取相应的设备权限:

  2. 添加前:



添加后:



  1. 若你的项目已启用 App Sandbox 或 Hardened Runtime 设置,则需勾选如下内容,获取相应的设备权限:

  2. 根据苹果官方要求:


  • 对于在 Mac App Store 发布的软件,需要启用 App Sandbox 设置。详见苹果官方声明。

  • 对于不在 Mac App Store 发布的软件,需要启用 Hardened Runtime 设置。详见苹果官方声明。

实现音视频通话

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


1. 创建用户界面

根据场景需要,为你的项目创建音视频通话的用户界面。若已有用户界面,可以直接查看导入类。


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


  • 本地视频窗口

  • 远端视频窗口

  • 结束通话按钮

  • 当你使用示例项目中的 UI 设计时,你将会看到如下界面:

2. 导入类

在项目中导入 AgoraRtcEngineKit 类:


// Objective-C#import <AgoraRtcEngineKit/AgoraRtcEngineKit.h>// Swiftimport AgoraRtcEngineKit
复制代码


Agora Native SDK 默认使用 libc++ (LLVM),如需使用 libstdc++ (GNU),请联系 sales@agora.io。SDK 提供的库是 Fat Image,包含 32/64 位模拟器、32/64 位真机版本。

3. 初始化 AgoraRtcEngineKit

在调用其他 Agora API 前,需要创建并初始化 AgoraRtcEngineKit 对象。


你需要在该步骤中填入项目的 App ID。请参考如下步骤在控制台创建 Agora 项目并获取 App ID。


1.登录控制台,点击左侧导航栏的项目管理图标 。


2.点击创建,按照屏幕提示设置项目名,选择一种鉴权机制,然后点击提交。


3.在项目管理页面,你可以获取该项目的 App ID。


调用 sharedEngineWithAppId 方法,传入获取到的 App ID,即可初始化 AgoraRtcEngineKit。


你还可以根据场景需要,在初始化时注册想要监听的回调事件,如本地用户加入频道及解码远端用户视频首帧等。


// Objective-C- (void)initializeAgoraEngine {    // 输入 App ID 并初始化 AgoraRtcEngineKit 类    self.agoraKit = [AgoraRtcEngineKit sharedEngineWithAppId:appID delegate:self];}// Swiftfunc initializeAgoraEngine() {   // 输入 App ID 并初始化 AgoraRtcEngineKit 类。   agoraKit = AgoraRtcEngineKit.sharedEngine(withAppId: AppID, delegate: self)}
复制代码

4. 设置本地视图

如果你想实现一个语音通话,可以直接查看加入频道。


成功初始化 AgoraRtcEngineKit 对象后,需要在加入频道前设置本地视图,以便在通话中看到本地图像。参考以下步骤设置本地视图:


  • 调用 enableVideo 方法启用视频模块。

  • 调用 setupLocalVideo 方法设置本地视图。


// Objective-C// 启用视频模块[self.agoraKit enableVideo];- (void)setupLocalVideo {    AgoraRtcVideoCanvas *videoCanvas = [[AgoraRtcVideoCanvas alloc] init];    videoCanvas.uid = 0;    videoCanvas.view = self.localVideo;    videoCanvas.renderMode = AgoraVideoRenderModeHidden;    // 设置本地视图    [self.agoraKit setupLocalVideo:videoCanvas];}
复制代码


// Swift// 启用视频模块agoraKit.enableVideo()func setupLocalVideo() {  let videoCanvas = AgoraRtcVideoCanvas()  videoCanvas.uid = 0  videoCanvas.view = localVideo  videoCanvas.renderMode = .hidden  // 设置本地视图  agoraKit.setupLocalVideo(videoCanvas)}
复制代码

5. 加入频道

完成初始化和设置本地视图后(视频通话场景),你就可以调用 joinChannelByToken 方法加入频道。你需要在该方法中传入如下参数:


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

  • token:传入能标识用户角色和权限的 Token。可设为如下一个值:

  • 若项目已启用 App 证书,请使用 Token。

  • nil

  • 临时 Token。临时 Token 服务有效期为 24 小时。你可以在控制台里生成一个临时 Token,详见获取临时 Token。

  • 在你的服务器端生成的 Token。在安全要求高的场景下,我们推荐你使用此种方式生成的 Token,详见生成 Token。

  • uid: 本地用户的 ID。数据类型为整型,且频道内每个用户的 uid 必须是唯一的。若将 uid 设为 0,则 SDK 会自动分配一个 uid,并在 joinSuccessBlock 回调中报告。

  • joinSuccessBlock:成功加入频道回调。joinSuccessBlock 优先级高于 didJoinChannel,2 个同时存在时,didJoinChannel 会被忽略。需要有 didJoinChannel 回调时,请将 joinSuccessBlock 设置为 nil。

  • 更多的参数设置注意事项请参考 joinChannelByToken 接口中的参数描述。


// Objective-C- (void)joinChannel {    // 加入频道    [self.agoraKit joinChannelByToken:token channelId:@"demoChannel1" info:nil uid:0 joinSuccess:^(NSString *channel, NSUInteger uid, NSInteger elapsed) {    }];}
复制代码


// Swiftfunc joinChannel() {    // 加入频道    agoraKit.joinChannel(byToken: Token, channelId: "demoChannel1", info:nil, uid:0) { [unowned self] (channel, uid, elapsed) -> Void in}    self.isLocalVideoRender = true            self.logVC?.log(type: .info, content: "did join channel")        }        isStartCalling = true}
复制代码

6. 设置远端视图

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


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


// Objective-C// 监听 firstRemoteVideoDecodedOfUid 回调。// SDK 接收到第一帧远端视频并成功解码时,会触发该回调。// 可以在该回调中调用 setupRemoteVideo 方法设置远端视图。- (void)rtcEngine:(AgoraRtcEngineKit *)engine firstRemoteVideoDecodedOfUid:(NSUInteger)uid size: (CGSize)size elapsed:(NSInteger)elapsed {    if (self.remoteVideo.hidden) {        self.remoteVideo.hidden = NO;    }    AgoraRtcVideoCanvas *videoCanvas = [[AgoraRtcVideoCanvas alloc] init];    videoCanvas.uid = uid;    videoCanvas.view = self.remoteVideo;    videoCanvas.renderMode = AgoraVideoRenderModeHidden;    // 设置远端视图    [self.agoraKit setupRemoteVideo:videoCanvas];}
复制代码


// Swift// 监听 firstRemoteVideoDecodedOfUid 回调。// SDK 接收到第一帧远端视频并成功解码时,会触发该回调。// 可以在该回调中调用 setupRemoteVideo 方法设置远端视图。func rtcEngine(_ engine: AgoraRtcEngineKit, firstRemoteVideoDecodedOfUid uid:UInt, size:CGSize, elapsed:Int) {        isRemoteVideoRender = true        let videoCanvas = AgoraRtcVideoCanvas()        videoCanvas.uid = uid        videoCanvas.view = remoteVideo        videoCanvas.renderMode = .hidden        // 设置远端视图        agoraKit.setupRemoteVideo(videoCanvas)    }
复制代码

7. 离开频道

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


// Objective-C- (void)leaveChannel {    // 离开频道。    [self.agoraKit leaveChannel:^(AgoraChannelStats *stat)}// Swiftfunc leaveChannel() {// 离开频道 AgoraKit.leaveChannel(nil) AgoraKit.setupLocalVideo(nil) remoteVideo.removeFromSuperview() localVideo.removeFromSuperview() delegate?.VideoChatNeedClose(self) AgoraKit = nil view.window!.close() }
复制代码


示例代码


你可以在 Agora-macOS-Tutorial-Objective-C-1to1/Agora-macOS-Tutorial-Swift-1to1 示例项目的 VideoChatViewController.m/VideoChatViewController.swift 文件中查看完整的源码和代码逻辑。

运行项目

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


本文转载自声网 Agora 公众号。


原文链接:https://mp.weixin.qq.com/s/kjXG083VpM_a8Ky4WvvO7Q


2020-02-25 15:16969

评论

发布
暂无评论
发现更多内容

孔再华:openGauss在民生银行的应用实践

阿里逆天级调优方案,内部这套Java性能调优实战宝典,堪称教科书

做梦都在改BUG

Java 性能优化 性能调优

路由器、网桥和交换机

测吧(北京)科技有限公司

测试

复旦MOSS大模型开源了!Github和Hugging Face同时上线

Openlab_cosmoplat

人工智能 开源项目 ChatGPT

openGauss:共建数据库根社区,打造开源数据库核心竞争力

Gradio入门到进阶全网最详细教程[一]:快速搭建AI算法可视化部署演示(侧重项目搭建和案例分享)

汀丶人工智能

人工智能 机器学习 深度学习 Gradio streamlit

精彩回顾 | DTC模式构建全域消费者增长指南

游读分享

分布式多级缓存系统设计与实战

做梦都在改BUG

分布式 系统设计 多级缓存

Nginx常用配置及和基本功能讲解

京东科技开发者

nginx 负载均衡 正向代理与反向代理 企业号 4 月 PK 榜 Nginx入门

算法题每日一练:最长递增子序列

知心宝贝

数据结构 算法 前端 后端 三周年连更

再次!openGauss荣获中国软协产业协会多个奖项

用户订阅付费如何拆解分析?看这篇就够了

HarmonyOS SDK

HMS Core

连接OpenAI两大智能产品Whisper & DALL·E,实现智能语音转文本/文本转图像

集简云开放平台

AI 智能 openai 数据集成平台 AI绘画

李士福:openGauss 自驾驶数据库内核在AI领域的探索和创新

沉默的618下,美妆品牌如何踏上破局之路?

游读分享

区块链数字代币燃烧模式开发技术方案丨(成熟技术)

I8O28578624

语雀-使用指南

六月的雨在InfoQ

在线文档 在线协同文档 三周年连更 语雀

Qz学算法-数据结构篇(查找算法--线性、二分)

浅辄

数据结构 三周年连更

软件测试/测试开发丨Pytest 自动化测试框架(四)

测试人

软件测试 自动化测试 测试开发 pytest

使用AI优化慢SQL,开发秒变DBA

NineData

sql AI 开发者 dba NineData

流量即生意!红海中的茶饮品牌如何做增量?

游读分享

宠物行业如何做留存?答案都在这里了!

游读分享

openGauss数据库源码解析系列文章——执行器解析(三)

深扒Sentinel背后的实现原理之后,我终于明白它为什么这么强了

Java你猿哥

Java spring ssm Sentine

JUnit 5 参数化测试

码语者

Java JUnit

黄凯耀:深度解读openGauss架构创新与新特性

阿里“宝妈级”之作,这份Spring Security应用到源码手册,全是精华

做梦都在改BUG

Java spring spring security

Josh × 微帧科技,为印度TOP短视频平台提供视频编码服务

微帧Visionular

音视频 视频编码 音视频技术

迪斯克Disrupt DEX众筹挖矿系统开发技术

薇電13242772558

dapp

用友联合7家信创生态伙伴成立“信创领先实践联盟”,助力企业数智化国产替代

用友BIP

Java 应用程序在 Kubernetes 上棘手的内存管理

Java你猿哥

Kubernetes JVM ssm requests limits

基于 Agora SDK 实现 macOS 端的一对一视频通话_文化 & 方法_声网_InfoQ精选文章