[已存档] Agora iOS 视频 UI 工具包

⚠️此项目已不再维护并已存档。
请注意,此存储库现在处于只读状态,不会收到任何进一步的更新或支持。 我们建议迁移到以下替代方案:

有关文档和支持,请访问 Agora 文档


使用 iOS 在您自己的应用程序或原型中立即集成 Agora。 对于 macOS,请参阅 VideoUIKit-macOS

更多信息请访问此存储库的 Wiki

点击此处查看完整文档

要查看此存储库中其他软件包的完整文档,例如 AgoraBroadcastExtensionHelperAgoraAppGroupDataHelperAgoraRtmControl,请在此处查看它们

要求

拥有 Agora 开发者账户和 App ID 后,您就可以使用此软件包了。

安装

Swift Package Manager 和 CocoaPods 均可用于安装方法。

此软件包的 Pod 称为 AgoraUIKit_iOS,适用于 iOS 平台,AgoraUIKit_macOS 适用于 macOS 平台。

有关安装软件包的更多信息,请参阅 安装 wiki 页面。

用法

安装完成后,打开您的应用程序 .xcodeproj 文件。 或者,如果您使用 CocoaPods,则打开 .xcworkspace 文件。

Agora UIKit 的主要视图是 AgoraVideoViewer。 这是一个最小创建示例,可为您提供类似于本 README 顶部所示的视图

import AgoraRtcKit
import AgoraUIKit

let agoraView = AgoraVideoViewer(
    connectionData: AgoraConnectionData(
        appId: "<#my-app-id#>",
        rtcToken: "<#my-channel-token#>",
        rtmToken: "<#my-channel-rtm-token#>"
    ), delegate: self
)

将您新创建的 AgoraVideoViewer 放入应用程序场景中,然后通过调用以下代码加入频道

agoraView.join(channel: "test", as: .broadcaster)

更多示例请访问 wiki

屏幕共享

有关使用 Agora 视频 UI 工具包和 AgoraBroadcastExtensionHelper 快速入门 进行屏幕共享的示例,请查看此处的示例项目

https://github.com/AgoraIO-Community/Video-UI-Kit-ScreenShare

文档

有关完整文档,请参阅我们的 AgoraUIKit 文档页面

对于此软件包中的其他库

错误处理和故障排除

有关如何克服一些常见错误的提示,请参阅 wiki 页面

路线图

UI 工具包

计划是扩展此库,并在所有受支持的平台上提供类似的产品。 已经有适用于 AndroidReact NativeFlutterWeb React 的类似库,请务必查看它们。

UML 图

UML of AgoraUIKit

UML of AgoraRtmControl

使用 swiftplantuml classdiagram Sources 生成