Dev Center
Voice Call
Agora.io Community
English
search-icon
Agora C++ API Reference for All Platforms
Index IRtcEngine RtcEngineParameters IRtcEngineEventHandler IAudioDeviceManager IVideoDeviceManager Warning Codes Error Codes

Public Member Functions

virtual void release ()=0
 
virtual int registerAudioFrameObserver (IAudioFrameObserver *observer)=0
 
virtual int registerVideoFrameObserver (IVideoFrameObserver *observer)=0
 
virtual int registerVideoRenderFactory (IExternalVideoRenderFactory *factory)=0
 
virtual int pushAudioFrame (MEDIA_SOURCE_TYPE type, IAudioFrameObserver::AudioFrame *frame, bool wrap)=0
 
virtual int pushAudioFrame (IAudioFrameObserver::AudioFrame *frame)=0
 
virtual int pullAudioFrame (IAudioFrameObserver::AudioFrame *frame)=0
 
virtual int setExternalVideoSource (bool enable, bool useTexture)=0
 
virtual int pushVideoFrame (ExternalVideoFrame *frame)=0
 

Member Function Documentation

◆ release()

virtual void agora::media::IMediaEngine::release ( )
pure virtual

◆ registerAudioFrameObserver()

virtual int agora::media::IMediaEngine::registerAudioFrameObserver ( IAudioFrameObserver *  observer)
pure virtual

Registers an audio frame observer object.

This method is used to register an audio frame observer object (register a callback). This method is required to register callbacks when the engine is required to provide an onRecordAudioFrame or onPlaybackAudioFrame callback.

Parameters
observerAudio frame observer object instance. If NULL is passed in, the registration is canceled.
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerVideoFrameObserver()

virtual int agora::media::IMediaEngine::registerVideoFrameObserver ( IVideoFrameObserver *  observer)
pure virtual

Registers a video frame observer object.

This method is required to register callbacks when the engine is required to provide an onCaptureVideoFrame or onRenderVideoFrame callback.

Parameters
observerVideo frame observer object instance. If NULL is passed in, the registration is canceled.
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerVideoRenderFactory()

virtual int agora::media::IMediaEngine::registerVideoRenderFactory ( IExternalVideoRenderFactory *  factory)
pure virtual

DEPRECATED

◆ pushAudioFrame() [1/2]

virtual int agora::media::IMediaEngine::pushAudioFrame ( MEDIA_SOURCE_TYPE  type,
IAudioFrameObserver::AudioFrame *  frame,
bool  wrap 
)
pure virtual

DEPRECATED Use pushAudioFrame(IAudioFrameObserver::AudioFrame* frame) instead.

Pushes the external audio frame.

Parameters
typeType of audio capture device: MEDIA_SOURCE_TYPE.
frameAudio frame pointer: AudioFrame.
wrapWhether to use the placeholder. We recommend setting the default value.
  • true: Use.
  • false: (Default) Not use.
Returns
  • 0: Success.
  • < 0: Failure.

◆ pushAudioFrame() [2/2]

virtual int agora::media::IMediaEngine::pushAudioFrame ( IAudioFrameObserver::AudioFrame *  frame)
pure virtual

Pushes the external audio frame.

Parameters
framePointer to the audio frame: AudioFrame.
Returns
  • 0: Success.
  • < 0: Failure.

◆ pullAudioFrame()

virtual int agora::media::IMediaEngine::pullAudioFrame ( IAudioFrameObserver::AudioFrame *  frame)
pure virtual

Pulls the external audio frame for external audio playback.

The application pulls the mixed audio frame from the audio engine for external audio playback. We recommend using pullAudioFrame over onPlaybackAudioFrame.

Note
This method overrides the registerAudioFrameObserver method. After calling pullAudioFrame, the application will not retrieve any audio frame from the onPlaybackAudioFrame callback.

Before calling this method:

  1. Call setExternalAudioSink to inform the audio engine that the application will call pullAudioFrame to pull audio frames from the sink.
  2. Call setPlaybackAudioFrameParameters to set the parameters of the audio frame to be pulled, including the audio sample rate and number of the audio channel.

Differences between onPlaybackAudioFrame and pullAudioFrame:

  • onPlaybackAudioFrame sends audio frames to the application once every 10 ms. Any delay in processing the audio frames may result in audio jitter.
  • With pullAudioFrame, the application pulls the audio frame. The SDK specifies the number of audio samples for playback by the sample parameter in AudioFrame, adjusts the frame buffer, and allows for a delay in processing the audio frames by the application. This method avoids problems caused by jitter in the external audio playback, such as an unsynchronized audio playback.
Parameters
framePointer to the audio frame. See: AudioFrame.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setExternalVideoSource()

virtual int agora::media::IMediaEngine::setExternalVideoSource ( bool  enable,
bool  useTexture 
)
pure virtual

Configures the external video source.

Parameters
enableSets whether to use the external video source:
  • true: Use the external video source.
  • false: (Default) Do not use the external video source.
useTextureSets whether to use texture as an input:
  • true: Use texture as an input.
  • false: (Default) Do not use texture as an input.
Returns
  • 0: Success.
  • < 0: Failure.

◆ pushVideoFrame()

virtual int agora::media::IMediaEngine::pushVideoFrame ( ExternalVideoFrame *  frame)
pure virtual

Pushes the video frame using the ExternalVideoFrame and passes the video frame to the Agora SDK.

Parameters
frameVideo frame to be pushed. See ExternalVideoFrame.
Note
In the Communication profile, this method does not support video frames in the Texture format.
Returns
  • 0: Success.
  • < 0: Failure.
score