AgoraUIKit_iOS 4.1.1

AgoraUIKit_iOS 4.1.1

Max Cobb 维护。



 
依赖项
AgoraRtcEngine_iOS~> 4.2.0
AgoraRtmControl_iOS= 4.1.1
 

  • Max Cobb

Agora Video UI Kit for iOS


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

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

点击此处查看完整文档

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

系统要求

  • iOS 13.0+ 或 macOS 10.15 或更高版本
  • Xcode 12.3 或更高版本
  • CocoaPods(如果使用 CocoaPods 安装)
  • 一个 Agora 开发者账号

一旦您有了 Agora 开发者账号和 App ID,您就可以使用此包了。

安装

Swift 包管理器和 CocoaPods 都提供了安装方法。

本软件包的Pod命名为《AgoraUIKit_iOS》和《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中找到

屏幕共享

有关使用Agora Video UI Kit和AgoraBroadcastExtensionHelper 快速入门进行屏幕共享的示例,请参阅此处的示例项目

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

文档

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

有关此软件包中的其他库

错误处理和故障排除

有关解决一些常见错误的提示,请参阅wiki 页面

路线图

UIKits

计划是扩大这个库,并在所有支持的平台上提供类似的库。已经存在类似的库,例如 AndroidReact NativeFlutterWeb React,所以请确保查看它们。

UML 图

  • AgoraUIKit

UML of AgoraUIKit

  • AgoraRtmControl

UML of AgoraRtmControl

使用 swiftplantuml classdiagram Sources 生成