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.

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_VIDEO_FILTER_NAME or EXTENSION_AUDIO_FILTER_NAME: The name of the video or audio filter of the extension.
• Key-value pairs for setExtensionPropertyWithVendor: These key-value pairs configure the properties of the extension, such as enabling a feature and setting the parameters for a feature.

Prerequisites

Before proceeding, ensure that you have completed the following tasks:

• Integrate the SDK v4.0.0 Beta. Currently only this SDK supports extensions from the Agora Extensions Marketplace.

• Implement Video Call v4.0.0 Beta or Interactive Live Streaming v4.0.0 Beta in your Agora project.
• Download an extension package for macOS (.framework or .xcframework).

• Activate the extension in Agora Console.

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 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:

1. Enter the Agora Extensions Marketplace in Agora Console.
2. Click the extension you want to activate.
3. Click Implementation guides.