startScreenCaptureBySourceType

abstract startScreenCaptureBySourceType(
    sourceType: VideoSourceType,
    config: ScreenCaptureConfiguration
  ): number;

Details

This method, as well as startScreenCaptureByDisplayId and startScreenCaptureByWindowId, can all be used to enable screen capture, with the following differences:

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:

If you call this method to start screen capture, Agora recommends that you call stopScreenCaptureBySourceType to stop the capture and avoid using stopScreenCapture.

sourceType

The type of the video source. See VideoSourceType.

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 VideoSourceScreen(2).

config

The configuration of the captured screen. See ScreenCaptureConfiguration.