Agora Swift Package Manager
<p align="center">
<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>
<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>
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.
For a complete understanding of how to use the SDK and its various extensions, please refer to the full documentation.
[图片上传失败...(image-4843a9-1740384584111)]
Installation
To install the Agora Swift Video SDK, follow these steps:
- Open your Xcode project.
- Go to File > Swift Packages > Add Package Dependency.
- Paste the following URL of this repository:
https://github.com/AgoraIO/AgoraRtcEngine_iOS
- Xcode will offer you a choice of products to add. Make sure to select
RtcBasicfor 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.
Troubleshooting
If you encounter any issues during the installation process, try the following steps:
In Xcode, go to File > Swift Packages > Reset Package Caches.
Otherwise create a ticket and our support team will get back to you ASAP.
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!
