Agora C++ API Reference for All Platforms
Public Member Functions | List of all members
agora::media::IVideoFrameObserverEx Class Referenceabstract

Inherits agora::media::IVideoFrameObserver.

Public Member Functions

virtual ~IVideoFrameObserverEx ()
 
bool onCaptureVideoFrame (VideoFrame &videoFrame) final
 
bool onSecondaryCameraCaptureVideoFrame (VideoFrame &videoFrame) final
 
bool onScreenCaptureVideoFrame (VideoFrame &videoFrame) final
 
bool onSecondaryScreenCaptureVideoFrame (VideoFrame &videoFrame) final
 
bool onRenderVideoFrame (const char *channelId, rtc::uid_t remoteUid, VideoFrame &videoFrame) final
 
bool onTranscodedVideoFrame (VideoFrame &videoFrame) final
 
bool onMediaPlayerVideoFrame (VideoFrame &videoFrame, int mediaPlayerId) final
 
bool isExternal () final
 
virtual bool onCaptureVideoFrame (webrtc::VideoFrame &videoFrame)=0
 
virtual bool onSecondaryCameraCaptureVideoFrame (webrtc::VideoFrame &videoFrame)=0
 
virtual bool onScreenCaptureVideoFrame (webrtc::VideoFrame &videoFrame)=0
 
virtual bool onSecondaryScreenCaptureVideoFrame (webrtc::VideoFrame &videoFrame)=0
 
virtual bool onRenderVideoFrame (const char *channelId, rtc::uid_t remoteUid, const webrtc::VideoFrame &videoFrame)=0
 
virtual bool onTranscodedVideoFrame (webrtc::VideoFrame &videoFrame)=0
 
virtual bool onMediaPlayerVideoFrame (webrtc::VideoFrame &videoFrame, int mediaPlayerId)=0
 
- Public Member Functions inherited from agora::media::IVideoFrameObserver
virtual ~IVideoFrameObserver ()
 
virtual VIDEO_FRAME_PROCESS_MODE getVideoFrameProcessMode ()
 
virtual base::VIDEO_PIXEL_FORMAT getVideoPixelFormatPreference ()
 
virtual int getRotationApplied ()
 
virtual bool getMirrorApplied ()
 

Additional Inherited Members

- Public Types inherited from agora::media::IVideoFrameObserver
enum  VIDEO_FRAME_PROCESS_MODE { PROCESS_MODE_READ_ONLY, PROCESS_MODE_READ_WRITE }
 
typedef media::base::VideoFrame VideoFrame
 

Detailed Description

The IVideoFrameObserverEx class.

Constructor & Destructor Documentation

◆ ~IVideoFrameObserverEx()

virtual agora::media::IVideoFrameObserverEx::~IVideoFrameObserverEx ( )
inlinevirtual

Member Function Documentation

◆ onCaptureVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onCaptureVideoFrame ( VideoFrame videoFrame)
inlinefinalvirtual

Occurs each time the SDK receives a video frame captured by the local camera.

After you successfully register the video frame observer, the SDK triggers this callback each time a video frame is received. In this callback, you can get the video data captured by the local camera. You can then pre-process the data according to your scenarios.

After pre-processing, you can send the processed video data back to the SDK by setting the videoFrame parameter in this callback.

Parameters
videoFrameA pointer to the video frame: VideoFrame
Returns
Determines whether to ignore the current video frame if the pre-processing fails:
  • true: Do not ignore.
  • false: Ignore, in which case this method does not sent the current video frame to the SDK.

Implements agora::media::IVideoFrameObserver.

◆ onSecondaryCameraCaptureVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onSecondaryCameraCaptureVideoFrame ( VideoFrame videoFrame)
inlinefinalvirtual

◆ onScreenCaptureVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onScreenCaptureVideoFrame ( VideoFrame videoFrame)
inlinefinalvirtual

Occurs each time the SDK receives a video frame captured by the screen.

After you successfully register the video frame observer, the SDK triggers this callback each time a video frame is received. In this callback, you can get the video data captured by the screen. You can then pre-process the data according to your scenarios.

After pre-processing, you can send the processed video data back to the SDK by setting the videoFrame parameter in this callback.

Parameters
videoFrameA pointer to the video frame: VideoFrame
Returns
Determines whether to ignore the current video frame if the pre-processing fails:
  • true: Do not ignore.
  • false: Ignore, in which case this method does not sent the current video frame to the SDK.

Implements agora::media::IVideoFrameObserver.

◆ onSecondaryScreenCaptureVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onSecondaryScreenCaptureVideoFrame ( VideoFrame videoFrame)
inlinefinalvirtual

◆ onRenderVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onRenderVideoFrame ( const char *  channelId,
rtc::uid_t  remoteUid,
VideoFrame videoFrame 
)
inlinefinalvirtual

Occurs each time the SDK receives a video frame sent by the remote user.

After you successfully register the video frame observer, the SDK triggers this callback each time a video frame is received. In this callback, you can get the video data sent by the remote user. You can then post-process the data according to your scenarios.

After post-processing, you can send the processed data back to the SDK by setting the videoFrame parameter in this callback.

Parameters
channelIdThe channel name
remoteUidID of the remote user who sends the current video frame.
videoFrameA pointer to the video frame: VideoFrame
Returns
Determines whether to ignore the current video frame if the post-processing fails:
  • true: Do not ignore.
  • false: Ignore, in which case this method does not sent the current video frame to the SDK.

Implements agora::media::IVideoFrameObserver.

◆ onTranscodedVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onTranscodedVideoFrame ( VideoFrame videoFrame)
inlinefinalvirtual

◆ onMediaPlayerVideoFrame() [1/2]

bool agora::media::IVideoFrameObserverEx::onMediaPlayerVideoFrame ( VideoFrame videoFrame,
int  mediaPlayerId 
)
inlinefinalvirtual

Occurs each time the SDK receives a video frame decoded by the MediaPlayer.

After you successfully register the video frame observer, the SDK triggers this callback each time a video frame is decoded. In this callback, you can get the video data decoded by the MediaPlayer. You can then pre-process the data according to your scenarios.

After pre-processing, you can send the processed video data back to the SDK by setting the videoFrame parameter in this callback.

Parameters
videoFrameA pointer to the video frame: VideoFrame
mediaPlayerIdof the mediaPlayer.
Returns
Determines whether to ignore the current video frame if the pre-processing fails:
  • true: Do not ignore.
  • false: Ignore, in which case this method does not sent the current video frame to the SDK.

Implements agora::media::IVideoFrameObserver.

◆ isExternal()

bool agora::media::IVideoFrameObserverEx::isExternal ( )
inlinefinalvirtual

Indicate if the observer is for internal use. Note: Never override this function

Returns
  • true: the observer is for external use
  • false: the observer is for internal use

Reimplemented from agora::media::IVideoFrameObserver.

◆ onCaptureVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onCaptureVideoFrame ( webrtc::VideoFrame &  videoFrame)
pure virtual

◆ onSecondaryCameraCaptureVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onSecondaryCameraCaptureVideoFrame ( webrtc::VideoFrame &  videoFrame)
pure virtual

◆ onScreenCaptureVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onScreenCaptureVideoFrame ( webrtc::VideoFrame &  videoFrame)
pure virtual

◆ onSecondaryScreenCaptureVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onSecondaryScreenCaptureVideoFrame ( webrtc::VideoFrame &  videoFrame)
pure virtual

◆ onRenderVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onRenderVideoFrame ( const char *  channelId,
rtc::uid_t  remoteUid,
const webrtc::VideoFrame &  videoFrame 
)
pure virtual

◆ onTranscodedVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onTranscodedVideoFrame ( webrtc::VideoFrame &  videoFrame)
pure virtual

◆ onMediaPlayerVideoFrame() [2/2]

virtual bool agora::media::IVideoFrameObserverEx::onMediaPlayerVideoFrame ( webrtc::VideoFrame &  videoFrame,
int  mediaPlayerId 
)
pure virtual