StartScreenCaptureBySourceType

Starts screen capture.

UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
	int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenCaptureConfiguration& config);

Details

This method, as well as StartScreenCapture, StartScreenCaptureByDisplayId, and StartScreenCaptureByWindowId, all have the capability to start screen capture, with the following differences:
  • StartScreenCapture only applies to Android and iOS, whereas this method only applies to Windows and iOS.
  • StartScreenCaptureByDisplayId and StartScreenCaptureByWindowId only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
Attention:

Parameters

sourceType

The type of the video source. See EVIDEO_SOURCE_TYPE.

Note:
  • Windows supports up to four screen capture video streams.
  • macOS supports only one screen capture video stream. You can only set this parameter to VIDEO_SOURCE_SCREEN(2).
config
The configuration of the captured screen. See FScreenCaptureConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.