IVideoFrameObserver

The IVideoFrameObserver class.

You can call registerVideoFrameObserver to register or unregister an IVideoFrameObserver object.

onCaptureVideoFrame

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

onCaptureVideoFrame?(
    sourceType: VideoSourceType,
    videoFrame: VideoFrame
  ): boolean;

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 local devices. You can then pre-process the data according to your scenarios.

Once the pre-processing is complete, you can directly modify videoFrame in this callback, and set the return value to true to send the modified video data to the SDK.

Attention:
  • The video data that this callback gets has not been pre-processed, and is not watermarked, cropped, rotated or beautified.
  • If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.

Parameters

sourceType
Video source types, including cameras, screens, or media player. See VideoSourceType.
videoFrame
The video frame. See VideoFrame.
Note: The default value of the video frame data format obtained through this callback is as follows:
  • macOS: YUV 420
  • Windows: YUV 420

Returns

  • When the video processing mode is ProcessModeReadOnly:
    • true: Reserved for future use.
    • false: Reserved for future use.
  • When the video processing mode is ProcessModeReadWrite:
    • true: Sets the SDK to receive the video frame.
    • false: Sets the SDK to discard the video frame.

onPreEncodeVideoFrame

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

  onPreEncodeVideoFrame?(videoFrame: VideoFrame): boolean;

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:
  • The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.

Parameters

sourceType

The type of the video source. See VideoSourceType.

videoFrame
The video frame. See VideoFrame.
Note: The default value of the video frame data format obtained through this callback is as follows:
  • macOS: YUV 420
  • Windows: YUV 420

Returns

  • When the video processing mode is ProcessModeReadOnly:
    • true: Reserved for future use.
    • false: Reserved for future use.
  • When the video processing mode is ProcessModeReadWrite:
    • true: Sets the SDK to receive the video frame.
    • false: Sets the SDK to discard the video frame.

onRenderVideoFrame

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

  onRenderVideoFrame?(
    channelId: string,
    remoteUid: number,
    videoFrame: VideoFrame
  ): boolean;

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 sent from the remote end before rendering, and then process it according to the particular scenarios.

Attention:
  • If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.

Parameters

remoteUid
The user ID of the remote user who sends the current video frame.
videoFrame
The video frame. See VideoFrame.
Note: The default value of the video frame data format obtained through this callback is as follows:
  • macOS: YUV 420
  • Windows: YUV 420
channelId
The channel ID.

Returns

  • When the video processing mode is ProcessModeReadOnly:
    • true: Reserved for future use.
    • false: Reserved for future use.
  • When the video processing mode is ProcessModeReadWrite:
    • true: Sets the SDK to receive the video frame.
    • false: Sets the SDK to discard the video frame.