IAgoraRtcVideoFrameObserver - Interactive Live Streaming Premium (Legacy)

GetObservedFramePosition

Sets the frame position for the video observer.

public virtual VIDEO_OBSERVER_POSITION GetObservedFramePosition()
        {
            return VIDEO_OBSERVER_POSITION.POSITION_POST_CAPTURER | VIDEO_OBSERVER_POSITION.POSITION_PRE_RENDERER;
        }

After successfully registering the video data observer, the SDK uses this callback to determine whether to trigger OnCaptureVideoFrame , OnRenderVideoFrame and OnPreEncodeVideoFrame callback at each specific video frame processing position, so that you can observe the locally collected video data, the video data sent by the remote end, and the video data before encoding. You can set one or more positions you need to observe by modifying the return value according to your scenario:

(1 << 0) : The position after capturing the video data, which corresponds to the OnCaptureVideoFrame callback.
(1 << 1): The position before receiving the remote video data, which corresponds to the OnRenderVideoFrame callback.
(1 << 2): The position before encoding the video data, which corresponds to the OnPreEncodeVideoFrame callback.

Attention:

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

Returns

GetVideoFormatPreference

Occurs each time the SDK receives a video frame and prompts you to set the video format.

public virtual VIDEO_FRAME_TYPE GetVideoFormatPreference()
        {
            return VIDEO_FRAME_TYPE.FRAME_TYPE_RGBA;
        }

If you want to receive other video formats than YUV420, register this callback when calling RegisterVideoFrameObserver. After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. You need to set your preferred video data in the return value of this callback.

Returns

Sets the video format VIDEO_FRAME_TYPE:

FRAME_TYPE_YUV420 (0): (Default) YUV420.
FRAME_TYPE_RGBA (2): RGBA.

IsMultipleChannelFrameWanted

Sets whether to get video data from multiple channels in the multi-channel scenario.

public virtual bool IsMultipleChannelFrameWanted()
        {
            return true;
        }

Since: v3.0.1

After you register the video frame observer, the SDK triggers this callback every time it captures a video frame.

In the multi-channel scenario, if you want to get video data from multiple channels, you need to set the return value of this callback as true. After that, the SDK triggers the OnRenderVideoFrameEx callback to send you the received remote video frame and report which channel the video frame comes from.

Attention:

If you set the return value of this callback as true, the SDK triggers OnRenderVideoFrameEx to send the before-mixing video data. OnRenderVideoFrame will not be triggered. In the multi-channel scenario, Agora recommends setting the return value as true.
If you set the return value of this callback as false, the SDK triggers OnRenderVideoFrame to send you the received video data.

Returns

true: Receive video data from multiple channels.
false: Do not receive video data from multiple channels.

OnCaptureVideoFrame

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

public virtual bool OnCaptureVideoFrame(VideoFrame videoFrame)
        {
            return true;
        }

After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. 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 this callback.

Attention:

This callback does not support sending processed RGBA video data back to the SDK.
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

VideoFrame: Video frame data. See VideoFrame for details.

Returns

Whether to ignore the current video frame if the processing fails:

true: Do not ignore.
false: Ignore the current video frame, and do not send it back to the SDK.

OnPreEncodeVideoFrame

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

public virtual bool OnPreEncodeVideoFrame(VideoFrame videoFrame)
        {
            return true;
        }

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

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

Attention:

To get the video data captured from the second screen before encoding, you need to set (1 << 2) as a frame position through GetObservedFramePosition.
The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
This callback does not support sending processed RGBA video data back to the SDK.

Parameters

VideoFrame: Video frame data. See VideoFrame for details.

Returns

Whether to ignore the current video frame if the processing fails:

true: Do not ignore.
false: Ignore the current video frame, and do not send it back to the SDK.

OnRenderVideoFrame

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

public virtual bool OnRenderVideoFrame(uint uid, VideoFrame videoFrame)
        {
            return true;
        }

Since: v3.0.0

After you successfully register the video frame observer, the SDK triggers this callback each time 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 in this callback.

Attention: This callback does not support sending processed RGBA video data back to the SDK.

Parameters

uid: The ID of the remote user who sends the current video frame.
VideoFrame: Video frame data. See VideoFrame for details.

Returns

Whether to ignore the current video frame if the processing fails:

true: Do not ignore.
false: Ignore the current video frame, and do not send it back to the SDK.

OnRenderVideoFrameEx

Gets the video frame from multiple channels.

public virtual bool OnRenderVideoFrameEx(string channelId, uint uid, VideoFrame videoFrame)
        {
            return true;
        }

After you successfully register the video frame observer, if you set the return value of IsMultipleChannelFrameWanted as true, the SDK triggers this callback each time it receives a video frame from any of the channel.

You can process the video data retrieved from this callback according to your scenario, and send the processed data back to the SDK using the videoFrame parameter in this callback.

Attention: This callback does not support sending RGBA video data back to the SDK.

Parameters

channelId: The channel ID of this video frame.
uid: The ID of the user sending this video frame.
VideoFrame: Video frame data. See VideoFrame for details.

Returns

Whether to send this video frame to the SDK if post-processing fails:

true: Send the video frame.
false: Do not send the video frame.