From 4049c38f93f5e7eab4576c970dd2ad9749a4bd9b Mon Sep 17 00:00:00 2001 From: Max Cobb Date: Wed, 9 Aug 2023 10:15:39 +0100 Subject: [PATCH] updated README to have information about the extensions, support badge, and updated api reference url --- .spi.yml | 2 +- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 56 insertions(+), 11 deletions(-) diff --git a/.spi.yml b/.spi.yml index 8abae221..5a96ce27 100644 --- a/.spi.yml +++ b/.spi.yml @@ -1,3 +1,3 @@ version: 1 external_links: - documentation: "https://agoraio.github.io/AgoraRtcEngine_iOS/documentation/agorartckit/" \ No newline at end of file + documentation: "https://api-ref.agora.io/en/video-sdk/ios/4.x/documentation/agorartckit" \ No newline at end of file diff --git a/README.md b/README.md index 16f19599..02fc0715 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # Agora Swift Package Manager

- - + + + + + + +
+ @@ -13,22 +19,61 @@

-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'.