|
Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Instance Methods | |
| (BOOL) | - onCaptureVideoFrame: |
| (BOOL) | - onPreEncodeVideoFrame: |
| (BOOL) | - onScreenCaptureVideoFrame: |
| (BOOL) | - onPreEncodeScreenVideoFrame: |
| (BOOL) | - onRenderVideoFrame:uid:channelId: |
| (BOOL) | - onMediaPlayerVideoFrame:mediaPlayerId: |
| (BOOL) | - onCaptureVideoFrame:dstFrame: |
| (BOOL) | - onPreEncodeVideoFrame:dstFrame: |
| (BOOL) | - onScreenCaptureVideoFrame:dstFrame: |
| (BOOL) | - getRotationApplied |
| (BOOL) | - getMirrorApplied |
| (AgoraVideoFrameProcessMode) | - getVideoFrameProcessMode |
| (AgoraVideoFormat) | - getVideoPixelFormatPreference |
| (AgoraVideoFramePosition) | - getObservedFramePosition |
|
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.
| videoFrame | A pointer to the video frame: AgoraOutputVideoFrame |
|
optional |
|
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.
| videoFrame | A pointer to the video frame: VideoFrame |
|
optional |
Occurs each time the SDK receives a video frame captured by the screen. 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 screen. 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.
| videoFrame | A pointer to the video frame: AgoraOutputVideoFrame |
|
optional |
Occurs each time the SDK receives a video frame captured by the screen 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.
| videoFrame | A pointer to the video frame: VideoFrame |
|
optional |
|
optional |
|
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.
| uid | ID of the remote user who sends the current video frame. |
| channelId | Channel name. |
| videoFrame | A pointer to the video frame: AgoraOutputVideoFrame |
|
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.
| videoFrame | A pointer to the video frame: AgoraOutputVideoFrame |
| mediaPlayerId | of the mediaPlayer. |
|
optional |
Occurs each time the SDK receives a video frame captured by the local camera. Notes: If getVideoFrameProcessMode is read-write, 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.
| srcFrame | A pointer to the video frame: AgoraOutputVideoFrame |
| dstFrame | (inout params) A pointer to the video frame: AgoraOutputVideoFrame |
|
optional |
|
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.
| srcFrame | A pointer to the video frame: AgoraOutputVideoFrame |
| dstFrame | (inout params) A pointer to the video frame: AgoraOutputVideoFrame |
|
optional |
Occurs each time the SDK receives a video frame captured by the screen. 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 screen. 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.
| videoFrame | A pointer to the video frame: AgoraOutputVideoFrame |
| dstFrame | (inout params) A pointer to the video frame: AgoraOutputVideoFrame |
|
optional |
|
optional |
|
optional |
|
optional |
Occurs each time needs to get rotation angle.
|
optional |
Occurs each time needs to get whether mirror is applied or not.
|
optional |
Indicate the video frame mode of the observer.
|
optional |
Occurs each time needs to get preference video frame type.
|
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.
1.8.20