updateScreenCapture abstract method

Future<void> updateScreenCapture(
  1. ScreenCaptureParameters2 captureParams
)

Updates the parameter configuration for screen capture.

If system audio is not captured when screen sharing is enabled and you want to update the configuration and publish system audio, follow these steps: Call this method and set captureAudio to true. Call updateChannelMediaOptions and set publishScreenCaptureAudio to true to publish the screen capture audio. This method is applicable to Android and iOS only. On iOS, screen sharing is supported only on iOS 12.0 and later.

  • captureParams Encoding parameter configuration for screen sharing. 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. See Error Codes for details and resolution suggestions.

Implementation

Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams);