Voice SDK for C++
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- IRtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- IRtcEngineEx
  This interface class contains multi-channel methods.
- IRtcEngineEventHandler
  The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IAudioDeviceManager
  Audio device management methods.
- IAudioDeviceCollection
  The IAudioDeviceCollection interface. You can get the information of audio devices with this interface.
- IVideoDeviceManager
  Video device management methods.
- IVideoDeviceCollection
  You can get the information of video devices with this interface.
- IMediaEngine
  The IMediaEngine class.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioPcmFrameSink
  This class is used to get raw PCM audio.
- IAudioFrameObserverBase
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IPacketObserver
  The definition of IPacketObserver.
- IMetadataObserver
  The metadata observer.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- IFaceInfoObserver
  Facial information observer.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- IScreenCaptureSourceList
  The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.
- Struct and Enum
  This page lists all the definitions of Struct and the enums for C++.
- API Sunset Notice
  This page introduces the deprecated and deleted APIs in the SDK.

IAudioEncodedFrameObserver

The encoded audio observer.

onMixedAudioEncodedFrame

Gets the mixed and encoded audio data of the local and all remote users.

virtual void onMixedAudioEncodedFrame(const uint8_t* frameBuffer,  int length, const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;

After calling registerAudioEncodedFrameObserver and setting the audio profile as AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED, you can get the mixed and encoded audio data of the local and all remote users through this callback.

Parameters

frameBuffer: The audio buffer.
length: The data length (byte).
audioEncodedFrameInfo: Audio information after encoding. See EncodedAudioFrameInfo.

onPlaybackAudioEncodedFrame

Gets the encoded audio data of all remote users.

virtual void onPlaybackAudioEncodedFrame(const uint8_t* frameBuffer,  int length, const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;

After calling registerAudioEncodedFrameObserver and setting the encoded audio as AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK, you can get encoded audio data of all remote users through this callback.

Parameters

frameBuffer: The audio buffer.
length: The data length (byte).
audioEncodedFrameInfo: Audio information after encoding. See EncodedAudioFrameInfo.

onRecordAudioEncodedFrame

Gets the encoded audio data of the local user.

virtual void onRecordAudioEncodedFrame(const uint8_t* frameBuffer,  int length, const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;

After calling registerAudioEncodedFrameObserver and setting the encoded audio as AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD, you can get the encoded audio data of the local user from this callback.

Parameters

frameBuffer: The audio buffer.
length: The data length (byte).
audioEncodedFrameInfo: Audio information after encoding. See EncodedAudioFrameInfo.