Package io.agora.rtc2.video
Interface IVideoFrameObserver
public interface IVideoFrameObserver
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe position after capturing the video data, which corresponds to the onCaptureVideoFrame callback.static final intThe position before encoding the video data, which corresponds to the onPreEncodeVideoFrame callback.static final intThe position before receiving the remote video data, which corresponds to the onRenderVideoFrame callback.static final intObserver works as a pure renderer and will not modify the original frame.static final intObserver works as a filter that will process the video frame and affect the following frame processing in SDK.static final int2: BGRA.static final int0: Default format.static final int18: I010.static final int1: I420.static final int16: I422.static final int8: NV12.static final int3: NV21.static final int4: RGBA.static final int10: GL_TEXTURE_2Dstatic final int11: GL_TEXTURE_OES -
Method Summary
Modifier and TypeMethodDescriptionbooleanOccurs each time needs to get whether mirror is applied or not.intSets the frame position for the video observer.booleanOccurs each time needs to get rotation angle.intintIndicate the video frame mode of the observer.booleanonCaptureVideoFrame(int sourceType, VideoFrame videoFrame) Occurs each time the SDK receives a video frame captured by the local camera.booleanonMediaPlayerVideoFrame(VideoFrame videoFrame, int mediaPlayerId) Occurs each time the SDK receives a video frame decoded by the MediaPlayer.booleanonPreEncodeVideoFrame(int sourceType, VideoFrame videoFrame) Occurs each time the SDK receives a video frame before encoding.booleanonRenderVideoFrame(String channelId, int uid, VideoFrame videoFrame) Occurs each time the SDK receives a video frame sent by the remote user.
-
Field Details
-
PROCESS_MODE_READ_ONLY
static final int PROCESS_MODE_READ_ONLYObserver works as a pure renderer and will not modify the original frame.- See Also:
-
PROCESS_MODE_READ_WRITE
static final int PROCESS_MODE_READ_WRITEObserver works as a filter that will process the video frame and affect the following frame processing in SDK.- See Also:
-
POSITION_POST_CAPTURER
static final int POSITION_POST_CAPTURERThe position after capturing the video data, which corresponds to the onCaptureVideoFrame callback.- See Also:
-
POSITION_PRE_RENDERER
static final int POSITION_PRE_RENDERERThe position before receiving the remote video data, which corresponds to the onRenderVideoFrame callback.- See Also:
-
POSITION_PRE_ENCODER
static final int POSITION_PRE_ENCODERThe position before encoding the video data, which corresponds to the onPreEncodeVideoFrame callback.- See Also:
-
VIDEO_PIXEL_DEFAULT
static final int VIDEO_PIXEL_DEFAULT0: Default format.- See Also:
-
VIDEO_PIXEL_I420
static final int VIDEO_PIXEL_I4201: I420.- See Also:
-
VIDEO_PIXEL_BGRA
static final int VIDEO_PIXEL_BGRA2: BGRA.- See Also:
-
VIDEO_PIXEL_NV21
static final int VIDEO_PIXEL_NV213: NV21.- See Also:
-
VIDEO_PIXEL_RGBA
static final int VIDEO_PIXEL_RGBA4: RGBA.- See Also:
-
VIDEO_PIXEL_NV12
static final int VIDEO_PIXEL_NV128: NV12.- See Also:
-
VIDEO_TEXTURE_2D
static final int VIDEO_TEXTURE_2D10: GL_TEXTURE_2D- See Also:
-
VIDEO_TEXTURE_OES
static final int VIDEO_TEXTURE_OES11: GL_TEXTURE_OES- See Also:
-
VIDEO_PIXEL_I422
static final int VIDEO_PIXEL_I42216: I422.- See Also:
-
VIDEO_PIXEL_I010
static final int VIDEO_PIXEL_I01018: I010. 10bit I420 data.- See Also:
-
-
Method Details
-
onCaptureVideoFrame
boolean onCaptureVideoFrame(int sourceType, 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. After pre-processing, you can send the processed video data back to the SDK by setting the `videoFrame` parameter in this callback.- Parameters:
sourceType- - The video source type.videoFrame- A pointer to the video frame.- 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 send the current video frame to the SDK.
-
onPreEncodeVideoFrame
boolean onPreEncodeVideoFrame(int sourceType, VideoFrame videoFrame) 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:
sourceType- - The video source type.videoFrame- A 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.
-
onMediaPlayerVideoFrame
boolean onMediaPlayerVideoFrame(VideoFrame videoFrame, int mediaPlayerId) 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:
videoFrame- A pointer to the video frame: VideoFramemediaPlayerId- of 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.
-
getVideoFrameProcessMode
int getVideoFrameProcessMode()Indicate the video frame mode of the observer.- Returns:
PROCESS_MODE_READ_ONLYorPROCESS_MODE_READ_WRITE
-
getVideoFormatPreference
int getVideoFormatPreference() -
getRotationApplied
boolean getRotationApplied()Occurs each time needs to get rotation angle.- Returns:
- rotation angle.
-
getMirrorApplied
boolean getMirrorApplied()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
int getObservedFramePosition()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.
-
onRenderVideoFrame
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:
channelId- Channel name.uid- ID of the remote user who sends the current video frame.videoFrame- A pointer to the video frame.- 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 send the current video frame to the SDK.
-