Agora RTC Objective-C API Reference  Refactor
Public Member Functions
IVideoFrameObserver Class Referenceabstract

Public Member Functions

virtual bool onCaptureVideoFrame (VideoFrame &videoFrame)=0
 
virtual bool onPreEncodeVideoFrame (VideoFrame &videoFrame)=0
 
virtual bool onSecondaryPreEncodeCameraVideoFrame (VideoFrame &videoFrame)=0
 
virtual bool onScreenCaptureVideoFrame (VideoFrame &videoFrame)=0
 
virtual bool onMediaPlayerVideoFrame (VideoFrame &videoFrame, int mediaPlayerId)=0
 
virtual bool onRenderVideoFrame (const char *channelId, rtc::uid_t remoteUid, VideoFrame &videoFrame)=0
 
virtual VIDEO_FRAME_PROCESS_MODE getVideoFrameProcessMode ()
 
virtual bool getRotationApplied ()
 
virtual bool getMirrorApplied ()
 
virtual uint32_t getObservedFramePosition ()
 
virtual bool isExternal ()
 

Detailed Description

The IVideoFrameObserver class.

Member Typedef Documentation

◆ VideoFrame

Member Enumeration Documentation

◆ VIDEO_FRAME_PROCESS_MODE

Enumerator
PROCESS_MODE_READ_ONLY 
PROCESS_MODE_READ_WRITE 

Constructor & Destructor Documentation

◆ ~IVideoFrameObserver()

virtual ~IVideoFrameObserver ( )
inlinevirtual

Member Function Documentation

◆ onCaptureVideoFrame()

virtual bool onCaptureVideoFrame ( VideoFrame videoFrame)
pure virtual

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.

The video data that this callback gets has not been pre-processed, without the watermark, the cropped content, the rotation, and the image enhancement.

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.

◆ onPreEncodeVideoFrame()

virtual bool onPreEncodeVideoFrame ( VideoFrame videoFrame)
pure virtual

Occurs each time the SDK receives a video frame before encoding.

After you successfully register the video frame observer, the SDK triggers this callback each time when it receives a video frame. In this callback, you can get the video data before encoding. You can then process the data according to your particular scenarios.

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

The video data that this callback gets has been pre-processed, with its content cropped, rotated, and the image enhanced.

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.

◆ onSecondaryCameraCaptureVideoFrame()

virtual bool onSecondaryCameraCaptureVideoFrame ( VideoFrame videoFrame)
pure virtual

◆ onSecondaryPreEncodeCameraVideoFrame()

virtual bool onSecondaryPreEncodeCameraVideoFrame ( VideoFrame videoFrame)
pure virtual

Occurs each time the SDK receives a video frame frome secondary camera before encoding.

After you successfully register the video frame observer, the SDK triggers this callback each time when it receives a video frame. In this callback, you can get the video data before encoding. You can then process the data according to your particular scenarios.

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

The video data that this callback gets has been pre-processed, with its content cropped, rotated, and the image enhanced.

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.

◆ onScreenCaptureVideoFrame()

virtual bool onScreenCaptureVideoFrame ( VideoFrame videoFrame)
pure virtual

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.

◆ onPreEncodeScreenVideoFrame()

virtual bool onPreEncodeScreenVideoFrame ( VideoFrame videoFrame)
pure virtual

◆ onMediaPlayerVideoFrame()

virtual bool onMediaPlayerVideoFrame ( VideoFrame videoFrame,
int  mediaPlayerId 
)
pure virtual

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.

◆ onSecondaryScreenCaptureVideoFrame()

virtual bool onSecondaryScreenCaptureVideoFrame ( VideoFrame videoFrame)
pure virtual

◆ onSecondaryPreEncodeScreenVideoFrame()

virtual bool onSecondaryPreEncodeScreenVideoFrame ( VideoFrame videoFrame)
pure virtual

◆ onRenderVideoFrame()

virtual bool onRenderVideoFrame ( const char *  channelId,
rtc::uid_t  remoteUid,
VideoFrame videoFrame 
)
pure virtual

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.

◆ onTranscodedVideoFrame()

virtual bool onTranscodedVideoFrame ( VideoFrame videoFrame)
pure virtual

◆ getVideoFrameProcessMode()

virtual VIDEO_FRAME_PROCESS_MODE getVideoFrameProcessMode ( )
inlinevirtual

Indicate the video frame mode of the observer.

Returns
VIDEO_FRAME_PROCESS_MODE

◆ getVideoFormatPreference()

virtual base::VIDEO_PIXEL_FORMAT getVideoFormatPreference ( )
inlinevirtual

◆ getRotationApplied()

virtual bool getRotationApplied ( )
inlinevirtual

Occurs each time needs to get rotation angle.

Returns
Determines whether to rotate.
  • true: need to rotate.
  • false: no rotate.

◆ getMirrorApplied()

virtual bool getMirrorApplied ( )
inlinevirtual

Occurs each time needs to get whether mirror is applied or not.

Returns
Determines whether to mirror.
  • true: need to mirror.
  • false: no mirror.

◆ getObservedFramePosition()

virtual uint32_t getObservedFramePosition ( )
inlinevirtual

Sets the frame position for the video observer.

After you successfully register the video observer, the SDK triggers this callback each time it receives a video frame. You can determine which position to observe by setting the return value. The SDK provides 3 positions for observer. Each position corresponds to a callback function:

POSITION_POST_CAPTURER(1 << 0): The position after capturing the video data, which corresponds to the onCaptureVideoFrame callback. POSITION_PRE_RENDERER(1 << 1): The position before receiving the remote video data, which corresponds to the onRenderVideoFrame callback. POSITION_PRE_ENCODER(1 << 2): The position before encoding the video data, which corresponds to the onPreEncodeVideoFrame callback.

To observe multiple frame positions, use '|' (the OR operator). This callback observes POSITION_POST_CAPTURER(1 << 0) and POSITION_PRE_RENDERER(1 << 1) by default. To conserve the system consumption, you can reduce the number of frame positions that you want to observe.

Returns
A bit mask that controls the frame position of the video observer: VIDEO_OBSERVER_POSITION.

◆ isExternal()

virtual bool isExternal ( )
inlinevirtual

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