Agora RTC Objective-C API Reference Refactor

Instance Methods
<AgoraVideoFrameDelegate> Protocol Reference

Inherits <NSObject>.

## Instance Methods
(BOOL) | - onCaptureVideoFrame:sourceType:
(BOOL) | - onPreEncodeVideoFrame:sourceType:
(BOOL) | - onRenderVideoFrame:uid:channelId:
(BOOL) | - onMediaPlayerVideoFrame:mediaPlayerId:
(BOOL) | - getRotationApplied
(BOOL) | - getMirrorApplied
(AgoraVideoFrameProcessMode) | - getVideoFrameProcessMode
(AgoraVideoFormat) | - getVideoFormatPreference
(AgoraVideoFramePosition) | - getObservedFramePosition

## Method Documentation

## ◆ onCaptureVideoFrame:sourceType:

- (BOOL) onCaptureVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame
sourceType: |  | (AgoraVideoSourceType) | sourceType
| optional

Occurs each time the SDK receives a video frame captured by the local camera. Notes: If getVideoFrameProcessMode is read-only, use MUST implement this method

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

  videoFrame | A pointer to the video frame: AgoraOutputVideoFrame

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.

## ◆ onPreEncodeVideoFrame:sourceType:

- (BOOL) onPreEncodeVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame
sourceType: |  | (AgoraVideoSourceType) | sourceType
| optional

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

  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.

## ◆ onTranscodedVideoFrame:

- (BOOL) onTranscodedVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional

## ◆ onRenderVideoFrame:uid:channelId:

- (BOOL) onRenderVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame
uid: |  | (NSUInteger) | uid
channelId: |  | (NSString *_Nonnull) | channelId
| optional

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

  uid | ID of the remote user who sends the current video frame.
  channelId | Channel name.
  videoFrame | A pointer to the video frame: AgoraOutputVideoFrame

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 sent the current video frame to the SDK.

## ◆ onMediaPlayerVideoFrame:mediaPlayerId:

- (BOOL) onMediaPlayerVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame
mediaPlayerId: |  | (NSInteger) | mediaPlayerId
| optional

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.

Note
  - This callback will not be affected by the return values of getVideoFrameProcessMode, getRotationApplied, getMirrorApplied, getObservedFramePosition.

Parameters

  videoFrame | A pointer to the video frame: AgoraOutputVideoFrame
  mediaPlayerId | 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.

## ◆ getRotationApplied

- (BOOL) getRotationApplied |  |  |
| optional

Occurs each time needs to get rotation angle.

Returns
  rotation angle.

## ◆ getMirrorApplied

- (BOOL) getMirrorApplied |  |  |
| optional

Occurs each time needs to get whether mirror is applied or not.

Returns
  Determines whether to mirror.
  - true: need to mirror.
  - false: no mirror.

## ◆ getVideoFrameProcessMode

- (AgoraVideoFrameProcessMode) getVideoFrameProcessMode |  |  |
| optional

Indicate the video frame mode of the observer.

Returns
  AgoraVideoFrameProcessMode

## ◆ getVideoFormatPreference

- (AgoraVideoFormat) getVideoFormatPreference |  |  |
| optional

Occurs each time needs to get preference video frame type.

Returns
  AgoraVideoFormat.

## ◆ getObservedFramePosition

- (AgoraVideoFramePosition) getObservedFramePosition |  |  |
| optional

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:

AgoraVideoFramePositionPostCapture(1 << 0): The position after capturing the video data, which corresponds to the onCaptureVideoFrame callback. AgoraVideoFramePositionPreRenderer(1 << 1): The position before receiving the remote video data, which corresponds to the onRenderVideoFrame callback. AgoraVideoFramePositionPreEncoder(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 AgoraVideoFramePositionPostCapture(1 << 0) and AgoraVideoFramePositionPreRenderer(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: AgoraVideoFramePosition.

## ◆ onCaptureVideoFrame:

- (BOOL) onCaptureVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional

## ◆ onSecondaryCameraCaptureVideoFrame:

- (BOOL) onSecondaryCameraCaptureVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional

## ◆ onScreenCaptureVideoFrame:

- (BOOL) onScreenCaptureVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional

## ◆ onSecondaryScreenCaptureVideoFrame:

- (BOOL) onSecondaryScreenCaptureVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional

## ◆ onPreEncodeVideoFrame:

- (BOOL) onPreEncodeVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional

## ◆ onPreEncodeScreenVideoFrame:

- (BOOL) onPreEncodeScreenVideoFrame: |  | (AgoraOutputVideoFrame *_Nonnull) | videoFrame |
| optional