Voice SDK v3.7.1 API Reference for Unity
Public Member Functions | List of all members
agora_gaming_rtc.VideoRawDataManager Class Reference

Inherits agora_gaming_rtc.IVideoRawDataManager.

Public Member Functions

delegate void  OnCaptureVideoFrameHandler (VideoFrame videoFrame)
 
delegate void  OnRenderVideoFrameHandler (uint uid, VideoFrame videoFrame)
 
override int  SetOnCaptureVideoFrameCallback (OnCaptureVideoFrameHandler action)
 
override int  SetOnRenderVideoFrameCallback (OnRenderVideoFrameHandler action)
 
override int  RegisterVideoRawDataObserver ()
 
override int  UnRegisterVideoRawDataObserver ()
 

Detailed Description

The definition of VideoRawDataManager.

Member Function Documentation

◆ OnCaptureVideoFrameHandler()

delegate void agora_gaming_rtc.VideoRawDataManager.OnCaptureVideoFrameHandler ( VideoFrame  videoFrame )

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.

Note
  • This callback does not support sending processed 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 See VideoFrame.

◆ OnRenderVideoFrameHandler()

delegate void agora_gaming_rtc.VideoRawDataManager.OnRenderVideoFrameHandler ( uint  uid,
VideoFrame  videoFrame 
)

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.

Note
This callback does not support sending processed video data back to the SDK.
Parameters
uid ID of the remote user who sends the current video frame.
videoFrame See VideoFrame.

◆ RegisterVideoRawDataObserver()

override int agora_gaming_rtc.VideoRawDataManager.RegisterVideoRawDataObserver ( )

Registers a video raw data observer.

Note
Ensure that you call this method before joining a channel.
Returns
  • 0: Success.
  • < 0: Failure.

◆ SetOnCaptureVideoFrameCallback()

override int agora_gaming_rtc.VideoRawDataManager.SetOnCaptureVideoFrameCallback ( OnCaptureVideoFrameHandler  action )

Listens for the OnCaptureVideoFrameHandler delegate.

Parameters
action The implementation of the OnCaptureVideoFrameHandler delegate.
Returns
  • 0: Success.
  • < 0: Failure.

◆ SetOnRenderVideoFrameCallback()

override int agora_gaming_rtc.VideoRawDataManager.SetOnRenderVideoFrameCallback ( OnRenderVideoFrameHandler  action )

Listens for the OnRenderVideoFrameHandler delegate.

Parameters
action The implementation of the OnRenderVideoFrameHandler delegate.
Returns
  • 0: Success.
  • < 0: Failure.

◆ UnRegisterVideoRawDataObserver()

override int agora_gaming_rtc.VideoRawDataManager.UnRegisterVideoRawDataObserver ( )

UnRegisters the video raw data observer.

Returns
  • 0: Success.
  • < 0: Failure.

The documentation for this class was generated from the following file: