Use an Extension

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:

• Audio effects and voice changing.
• Face filters and background removal.
• Live transcription and captioning.

This page shows you how to integrate and use an extension from the Agora Extensions Marketplace.

Understand the tech

To use an extension in your Agora project, implement the following steps in your app:

1. Enable the extension: Call enableExtensionWithVendor before joining a channel.
2. Use an extension feature: Call setExtensionPropertyWithVendor to pass in necessary parameters.

Prerequisites

To follow the procedure on this page, you must have:

• An Agora project that has successfully started Video Call or Interactive Live Streaming Premium.
• The Agora Video SDK v4.0.0 Preview. Currently only this SDK supports extensions.
• An extension package (.framework or .xcframwork) and details about the extension. See Get an extension.

Project setup

To create the environment necessary to integrate the extension into your app, do the following:
1. Save the .framework or .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 .framework or .xcframwork files you saved earlier.

Implement the extension in your project

The implementation procedure varies according to extensions. Each extension vendor provides their own implementation guides, which is validated by Agora before the official release of the extension.

To implement the extension in your project, go to the detail page of the extension on Agora Console, click Implementation guides, and follow the steps on the page.

Sample project

Agora provides an open-source sample project SimpleFilter on GitHub for your reference.