agoraio-community / videouikit-ios Goto Github PK

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

Home Page: https://agoraio-community.github.io/VideoUIKit-iOS/documentation/agorauikit

License: MIT License

Ruby 2.72% Swift 96.81% Shell 0.47%

macos cocoapods ios agoraio agora agora-sdk rtc video-streaming webrtc swift

videouikit-ios's Introduction

Agora Video UI Kit for iOS

Instantly integrate Agora in your own application or prototype using iOS. For macOS, see VideoUIKit-macOS.

More information available on this repo's Wiki

Click here for full documentation

To see full documentation for other packages in this repo, such as AgoraBroadcastExtensionHelper, AgoraAppGroupDataHelper or AgoraRtmControl, check them out here:

Requirements

iOS 13.0+ or a macOS 10.15 or later
Xcode 12.3 or later
CocoaPods (if installing with CocoaPods)
An Agora developer account

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_iOS and AgoraUIKit_macOS for the two available platforms.

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

Screen Sharing

For an example for screen sharing with Agora Video UI Kit and AgoraBroadcastExtensionHelper Quickstart, check out the example project here:

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

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.

Roadmap

Muting/Unmuting a remote member
Usernames (Settable value, not currently rendered)
Promoting an audience member to a broadcaster role.
Layout for Voice Calls
Cloud recording

UIKits

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

UML Diagrams

AgoraUIKit

AgoraRtmControl

generated with swiftplantuml classdiagram Sources

videouikit-ios's People

Contributors

Stargazers

Watchers

Forkers

williamdxz zakariahmusic jiayanana ragbadaskar keisukeminami mhamayun andrejtrajkovski burberryboy devonallary

videouikit-ios's Issues

[FEATURE] Join With Cam + Mic off

Describe the solution you'd like
Opting to join channel with camera and/or mic off

Describe alternatives you've considered
Muting either by code after joining would still require cam/mic permission to join

[BUG] SwiftUI Example does not work with RTM requests

Describe the bug
RTM request do not work for sending or receiving using SwiftUI View
This is because alerts can not be displayed with SwiftUI view representative

To Reproduce
Steps to reproduce the behavior:

Use SwiftUI Example on device 1
Use Other example on device 2 (macOS or iOS)
Send request to device 1 from 2 - alert doesn't show on device 1
Click send request button on device 1 - menu popup doesn't show

Expected behavior
Should be able to send requests

Desktop (please complete the following information):

OS: macOS
Version 11.5.2

Smartphone (please complete the following information):

Device: iPhone 12 Pro
OS: 14.7

Is it possible to receive a video call when the app is terminated, and answer this video call ?

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Screen sharing while video calling

Is your feature request related to a problem? Please describe.
Screen sharing while video calling.

Describe the solution you'd like
An options to share screen while talking with people. Here is the agora docs implementation of it - https://docs.agora.io/en/Video/screensharing_ios?platform=iOS

Is video calling on dynamic channels at same time is avalable in flutterUIkit

i am making an app which need to make multiple groups calls with different users by subadmins, is it possible using agoraUIKIT

Facing Multiple screen When Tap sharing pin view of collection

I am implemented screenSharing features use of UIKit screenSharing working good but when we tap on screen sharing view which is show in collection of style .floating then it show multiple view of sharing in device.

Some Methods are only available in iOS 13.0 or newer Error.

Describe the bug
I have installed the pod, and I am facing some issues with the files. Like

'secondarySystemBackground' is only available in iOS 13.0 or newer

To Reproduce
Steps to reproduce the behavior:

Create a project with target 13.0 and create pods
Install pods
Try to build.

Expected behavior
It should run without any error as my least target is 13.0

Screenshots

Smartphone (please complete the following information):

Device: any iPhones
OS: iOS 13.0

Icons are undefined for macOS

When building on macOS following instructions for minimal implementation, the icons are missing.

From the code in UIButton+Extensions:

    #elseif os(macOS)
    /// SF Symbol name for camera icon for builtin button
    static var videoSymbol = "􀌟"
    /// SF Symbol name for camera alt icon for builtin button
    static var muteVideoSelectedSymbol: String?
    /// SF Symbol name for microphone icon for builtin button
    static var micSymbol = "􀊰"
    /// SF Symbol for microphone alt icon for builtin button
    static var muteMicSelectedSymbol: String? = "􀊲"
    /// SF Symbol for microphone muted flag
    static var micSlashSymbol = "􀊲"
    /// SF Symbol for flip camera builtin button
    static var cameraRotateSymbol = "􀌢"
    /// SF Symbol for beautify buitlin button
    static var wandSymbol = "􀜎"
    /// SF Symbol to appear behind user with camera off
    static var personSymbol = "􀓣"
    /// SF Symbol for sharing screen builtin button
    static var screenShareSymbol = "􀏧"
    /// SF Symbol for pin icon
    static var pinSymbol = "􀎧"

This seems like a bug, or at least it makes the example confusing.

[BUG] Cannot pin user if their camera is off (iOS Only)

Describe the bug
If a remote user has their camera off, they cannot be manually pinned using floating layout.

To Reproduce
Steps to reproduce the behavior:

Join channel with two devices
Turn off remote camera feed
Attempt to select remote user from floating collection view
User does not get pinned

Expected behavior
User with camera off should get pinned.

Smartphone (please complete the following information):

Device: iPhone 12 Pro
OS: 14.5

Is it possible to change user avatar of local user and remote user when disableVideo(agkit.disableVideo())?

SwiftUI Example does not build

Error - Missing package product 'AgoraRtmControl'

[BUG] Extension Marketplace methods aren't public

Describe the bug
Extension marketplace are set to internal (default), should be public

To Reproduce
Steps to reproduce the behavior:
Create AgoraVideoViewer instance and try call the setExtensionProperty methods.

Expected behavior
Methods should be public or open.

Pod Not Working

When i tried to install pod file pod ‘AgoraUIKit', i am getting below error and there is no any documentation at agora site like how to implement iOS with pod file. I have done demo using Framework only but now need to do with Pod file but its not working.

Analyzing dependencies
[!] No podspec exists at path /Users/XXXX/.cocoapods/repos/trunk/Specs/1/d/9/AgoraRtcEngine_iOS/3.1.2.60/AgoraRtcEngine_iOS.podspec.json.

[!] Smart quotes were detected and ignored in your Podfile. To avoid issues in the future, you should not use TextEdit for editing it. If you are not using TextEdit, you should turn off smart quotes in your editor of choice.

[!] Automatically assigning platform iOS with version 12.0 on target AgoraDemo because no platform was specified. Please specify a platform for this target in your Podfile. See https://guides.cocoapods.org/syntax/podfile.html#platform.

Invalid Token Error while creating recording

Hello,

We are trying to create recording for one to one person.

We are calling an API to our server
Server generates token, sid, resourceid & uid and send back to front end
we are passing the same data to joinchannel method.

Still we are getting invalid token error

To Reproduce
Steps to reproduce the behavior:

From main thread, call - AgoraViewer.viewer.join(channel: channeId, as: role, fetchToken: true, uid: uid)

Expected behavior
AgoraUIKit should process fetchToken result in main thread

Screenshots

Smartphone (please complete the following information):

Device: iPhone 13
OS: iOS 15
Version 4.0.0-preview.12

agoraio-community / videouikit-ios Goto Github PK

videouikit-ios's Introduction

Agora Video UI Kit for iOS

Requirements

Installation

Usage

Screen Sharing

Documentation

Error Handling and Troubleshooting

Roadmap

UIKits

UML Diagrams

videouikit-ios's People

Contributors

Stargazers

Watchers

Forkers

videouikit-ios's Issues

Recommend Projects

Recommend Topics

Recommend Org