Skip to content

Commit

Permalink
updated README to have information about the extensions, support badg…
Browse files Browse the repository at this point in the history
…e, and updated api reference url
  • Loading branch information
maxxfrazer committed Aug 9, 2023
1 parent 2e035db commit 4049c38
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .spi.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
version: 1
external_links:
documentation: "https://agoraio.github.io/AgoraRtcEngine_iOS/documentation/agorartckit/"
documentation: "https://api-ref.agora.io/en/video-sdk/ios/4.x/documentation/agorartckit"
65 changes: 55 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,79 @@
# Agora Swift Package Manager

<p align="center">
<img src="https://github.com/AgoraIO/AgoraRtcEngine_iOS/actions/workflows/swiftpm-resolve.yml/badge.svg"/>
<a href="http://agoraio.github.io/AgoraRtcEngine_iOS/documentation/agorartckit/">
<a href="https://docs.agora.io/en/video-calling/overview/product-overview?platform=ios">
<img src="https://img.shields.io/badge/Documentation-View-F05138?logo=swift"/>
</a>
<a href="https://api-ref.agora.io/en/video-sdk/ios/4.x/documentation/agorartckit">
<img src="https://img.shields.io/badge/API%20Reference-View-F05138?logo=swift"/>
</a>
<a href="https://agora-ticket.agora.io">
<img src="https://img.shields.io/badge/Support-Create%20Ticket-blue?logo=jira"/>
</a>
<br/>
<img src="https://github.com/AgoraIO/AgoraRtcEngine_iOS/actions/workflows/swiftpm-resolve.yml/badge.svg"/>
<a href="https://swiftpackageindex.com/AgoraIO/AgoraRtcEngine_iOS" style="text-decoration: none;">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraRtcEngine_iOS%2Fbadge%3Ftype%3Dplatforms"/>
</a>
<a href="https://swiftpackageindex.com/AgoraIO/AgoraRtcEngine_iOS">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraRtcEngine_iOS%2Fbadge%3Ftype%3Dswift-versions"/>
</a>
</p>
Install Agora Video SDK easily with Swift Package Manager.

![](media/swiftpm-agora.png)
Welcome to the Agora Swift Video SDK! This package allows you to integrate powerful video capabilities into your iOS applications. You have the flexibility to choose from a variety of extensions to enhance your video communication experience.

[Click here for full documentation](https://docs.agora.io/en/video-calling/overview/product-overview?platform=ios).
For a complete understanding of how to use the SDK and its various extensions, please refer to the [full documentation](https://docs.agora.io/en/video-calling/overview/product-overview?platform=ios).

![](media/swiftpm-agora.png)

## Installation

Add the URL of this repository to your Xcode 12+ Project.
To install the Agora Swift Video SDK, follow these steps:

1. Open your Xcode project.
2. Go to **File** > **Swift Packages** > **Add Package Dependency**.
3. Paste the following URL of this repository:

```
https://github.com/AgoraIO/AgoraRtcEngine_iOS
```

4. Xcode will offer you a choice of products to add. Make sure to select **`RtcBasic`** for core functionality and choose any other extensions you require.

### Available Extensions

The Agora Swift Video SDK comes with various extensions that you can use to enhance your application's video capabilities:

| Extension | Description |
|-----------|-------------|
| **RtcBasic** | Core components for real-time communication (Required). |
| **AINS** | AI noise reduction with improved human voice fidelity, noise suppression, and de-reverberation. |
| **AudioBeauty** | Bel Canto plugin with preset vocal effects and custom vocal effects settings. |
| **ClearVision** | Video enhancement plugin with basic beauty, video noise reduction, low light enhancement, and color enhancement. |
| **ContentInspect** | Video screenshot upload plugin for video content supervision. |
| **SpatialAudio** | Spatial audio plugin for simulating spatial sound effects. |
| **VirtualBackground** | Virtual background plugin for replacing or blurring backgrounds. |
| **DRM** | Copyrighted DRM music plugin for playing copyrighted music in real-time interactive scenarios. |
| **FaceDetection** | Face recognition plugin for recognizing faces or portraits. |
| **VideoCodecEnc** | Perceptual Video Coding (PVC) insert for reducing bandwidth consumption. |
| **VideoCodecDec** | PVC insert for improving video fluency in limited bandwidth scenarios. |
| **ReplayKit** | Screen sharing plugin for sharing screen content with others. |
| **VQA** | Video quality assessment plugin for scoring video quality based on subjective feelings. |
| **AIAEC** | AI echo cancellation plugin for clear near-end human voice preservation. |
| **SuperResolution** | Super resolution plugin for increasing remote video resolution. |

For more detailed information on each extension and how to use them, refer to the [official documentation](https://docs.agora.io/en/video-calling/reference/downloads?platform=ios).


## Troubleshooting

If you encounter any issues during the installation process, try the following steps:

Go to File > Swift Packages > Add Package Dependency, and paste in the link to this repository:
In Xcode, go to File > Swift Packages > Reset Package Caches.

`https://github.com/AgoraIO/AgoraRtcEngine_iOS`
Otherwise [create a ticket](https://agora-ticket.agora.io) and our support team will get back to you ASAP.

---

If you have issues installing this Swift Package:
Feel free to explore and utilize the wide range of features provided by the Agora Swift Video SDK to create immersive and engaging video experiences in your application!

In Xcode's File menu, select 'Swift Packages' and then 'Reset Package Caches'.

0 comments on commit 4049c38

Please sign in to comment.