startScreenCapture [2/2]
Starts screen capture.
virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration& config) = 0;
Details
- Since
- v4.2.0
This method, as well as startScreenCapture [1/2], startScreenCaptureByDisplayId, and startScreenCaptureByWindowId, all have the capability to start screen capture, with the following differences:
- startScreenCapture [1/2] 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:
- This method applies to the macOS and Windows only.
- If you call this method to start screen capture, Agora recommends that you call stopScreenCapture [2/2] to stop the capture and avoid using stopScreenCapture [1/2].
Parameters
- sourceType
-
The type of the video source. See VIDEO_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 ScreenCaptureConfiguration.
Returns
- 0: Success.
- < 0: Failure.