Extensions are add-ons designed to extend the functionality of the Agora SDK. The Extensions Marketplace is home to extensions that make your app more fun. These extensions provide features such as:
This page shows you how to integrate and use an extension from the Agora Extensions Marketplace.
To use an extension in your Agora project, implement the following steps in your app:
enableExtensionWithVendorbefore joining a channel.
setExtensionPropertyWithVendorto pass in necessary parameters.
When you call these APIs, you need the following details about the extension:
EXTENSION_NAME: The name of the extension.
EXTENSION_VENDOR_NAME: The name of the extension vendor.
EXTENSION_AUDIO_FILTER_NAME: The name of the video or audio filter of the extension.
setExtensionPropertyWithVendor: These key-value pairs configure the properties of the extension, such as enabling a feature and setting the parameters for a feature.
Before proceeding, ensure that you have completed the following tasks:
To create the environment necessary to integrate the extension into your app, do the following:
1. Save the
.xcframwork files in your project folder.
2. In Xcode, open your project and select your target. Go to General > Frameworks, Libraries, and Embedded Content.
3. Click + > Add Other… > Add Files and select the
.xcframwork files you saved earlier.
The implementation procedure can vary according to extensions. Each extension vendor provides their own implementation guides, which is validated by Agora before the official release of the extension.
To access the implementation guides of an extension, follow these steps: