startScreenCaptureByDisplayId abstract method

Future<void> startScreenCaptureByDisplayId({
  1. required int displayId,
  2. required Rectangle regionRect,
  3. required ScreenCaptureParameters captureParams,
})

开始采集指定屏幕的视频流。

采集一个屏幕或该屏幕部分区域的视频流。 该方法仅适用于 Windows 和 macOS。

  • displayId 指定待共享的屏幕 ID。 对于 Windows 平台，如果你需要同时共享两个屏幕（主屏 + 副屏），可以在调用该方法时，将 displayId 设置为 -1 。
  • regionRect （可选）指定待共享区域相对于整个屏幕的位置。如需共享整个屏幕，则填 nil 。 详见 Rectangle 。
  • captureParams 屏幕共享的参数配置。默认的视频编码分辨率为 1920 × 1080，即 2073600 像素。该像素值为计费标准。详见 ScreenCaptureParameters 。 屏幕共享流的视频属性只需通过该参数设置，与 setVideoEncoderConfiguration 无关。

Returns 方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。

Implementation

Future<void> startScreenCaptureByDisplayId(
    {required int displayId,
    required Rectangle regionRect,
    required ScreenCaptureParameters captureParams});