[已存档] Agora Video UI Kit for macOS

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

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


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

更多信息请参见此仓库的 Wiki

点击此处获取完整文档

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

要求

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

安装

Swift Package Manager 和 CocoaPods 都提供安装方法。

此软件包的 Pod 称为 AgoraUIKit_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

文档

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

对于此软件包中的其他库

错误处理和故障排除

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

已知问题

如果未安装 SF Symbols,则图标可能不会显示。

路线图

其他视频 UI Kit

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

UML 图

UML of AgoraUIKit

UML of AgoraRtmControl

使用 swiftplantuml classdiagram Sources 生成