Interface IVideoFrameObserver

The IVideoFrameObserver class.

Hierarchy

  • IVideoFrameObserver

Methods

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

    You can get raw video data collected by the local device through this callback.

    Parameters

    • sourceType: VideoSourceType

      Video source types, including cameras, screens, or media player. See VideoSourceType.

    • videoFrame: VideoFrame

      The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows: Android: I420 iOS: I420

    Returns void

  • 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 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. It is recommended that you ensure the modified parameters in videoFrame are consistent with the actual situation of the video frames in the video frame buffer. Otherwise, it may cause unexpected rotation, distortion, and other issues in the local preview and remote video display. It's recommended that you implement this callback through the C++ API. Due to framework limitations, this callback does not support sending processed video data back to the SDK. The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.

    Parameters

    • sourceType: VideoSourceType

      The type of the video source. See VideoSourceType.

    • videoFrame: VideoFrame

      The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows: Android: I420 iOS: I420

    Returns void

  • 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 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. It is recommended that you ensure the modified parameters in videoFrame are consistent with the actual situation of the video frames in the video frame buffer. Otherwise, it may cause unexpected rotation, distortion, and other issues in the local preview and remote video display. If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel. It's recommended that you implement this callback through the C++ API. Due to framework limitations, this callback does not support sending processed video data back to the SDK.

    Parameters

    • channelId: string

      The channel ID.

    • remoteUid: number

      The user ID of the remote user who sends the current video frame.

    • videoFrame: VideoFrame

      The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows: Android: I420 iOS: I420

    Returns void

Generated using TypeDoc