Contents

AgoraIO-Community/VideoUIKit-macOS

Swift Package and CocoaPod to simply integrate Agora Video Calling or Live Video Streaming to your macOS app with just a few lines of code.

Requirements

Once you have an Agora developer account and an App ID, you're ready to use this package.

Installation

Swift Package Manager and CocoaPods are both available offered for installation methods.

The Pod for this package is called AgoraUIKit_macOS.

See the Installation wiki page for more information on installing the package.

Usage

Once installed, open your application .xcodeproj file. Or .xcworkspace if using CocoaPods.

The main view for Agora UIKit is AgoraVideoViewer. This is an example of a minimal creation that gives you a view similar to the one at the top of this 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
)

Frame your newly created AgoraVideoViewer in the app scene, then join a channel by calling:

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

More examples available on the wiki

Documentation

For full documentation, see our AgoraUIKit documentation page.

For other libraries in this package:

Error Handling and Troubleshooting

For tips on how to overcome some common errors, see the wiki page.

Known Issues

Icons may not display if SF Symbols is not installed.

Roadmap

Other Video UI Kits

The plan is to grow this library and have similar offerings across all supported platforms. There are already similar libraries for iOS, Android, React Native, Flutter and Web React so be sure to check them out.

UML Diagrams

  • AgoraUIKit

<p align="center"> <img src="media/uml_agorauikit.svg" alt="UML of AgoraUIKit"/> </p>

  • AgoraRtmControl

<p align="center"> <img src="media/uml_agorartmcontrol.svg" alt="UML of AgoraRtmControl"/> </p>

generated with swiftplantuml classdiagram Sources

Package Metadata

Repository: AgoraIO-Community/VideoUIKit-macOS

Homepage: https://agoraio-community.github.io/VideoUIKit-macOS/documentation/agorauikit/

Stars: 3

Forks: 3

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

Topics: agora, agoraio, agorasdk, ios, macos, swift, video-streaming

README: README.md

Archived: yes