updateScreenCapture abstract method

Future<void> updateScreenCapture(
  1. ScreenCaptureParameters2 captureParams
)

Updates the screen capturing parameters.

If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps: Call this method, and set captureAudio to true. Call updateChannelMediaOptions, and set publishScreenCaptureAudio to true to publish the audio captured by the screen. This method applies to Android and iOS only. On the iOS platform, screen sharing is only available on iOS 12.0 and later.

  • captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters2.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly.

Implementation

Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams);