Documentation
Voice Call v4.0.0 Beta
Console 官网 Community Technical support
English
search-icon

Custom Audio Source

Last updated 2022/09/27 02:06:22

The default Agora audio module interacts seamlessly with the devices your app runs on. The SDK enables you to add specialized audio features to your app using a custom audio source.!

Understand the tech

By default, SDK integrates the default audio modules on the device your app runs on for real-time communication. However, there are scenarios where you may want to integrate a custom audio capturer. For example:

  • Your app has its own audio module.
  • You want to use a pre-processing library for the audio data.
  • You need flexible device resource allocation to avoid conflicts with other services.

To manage the capture and processing of audio frames when using a custom audio source, use methods from outside the Agora SDK.

The API call sequence is as follows:

custom audio source api sequence

When customizing the audio source, you need to record and process the audio data on your own.

Prerequisites

Before adjusting the audio volume, ensure that you have implemented the basic real-time communication functions in your project. For details, see the following quickstart guides:

Implementation

To implement a custom audio source in your project, refer to the following steps.

  1. Before joining a channel, call setExternalAudioSource to notify the SDK to use the external audio source.

     agoraKit.setExternalAudioSource(true, sampleRate: Int(sampleRate), channels: Int(channel), sourceNumber: 1, localPlayback: true, publish: true)

  2. Record and process the audio data on your own.

  3. Send the audio data back to the SDK using pushExternalAudioFrameSampleBuffer, or pushExternalAudioFrameNSData.

     extension CustomPcmAudioSourceMain: AgoraPcmSourcePushDelegate {
     func onAudioFrame(data: Data) {
         agoraKit.pushExternalAudioFrameNSData(data, sourceId: 0, timestamp: 0)
     }
 }

Reference

This section includes in depth information about the methods you used in this page, and links to related pages.

Sample project

Agora provides the following open-sourced sample projects that implement custom audio source functions:

API reference