ScreenCaptureParameters

Used to configure screen sharing functionality.

public class ScreenCaptureParameters {
  public boolean captureAudio = false;
  public VideoCaptureParameters videoCaptureParameters = new VideoCaptureParameters();
  public boolean captureVideo = true;
  public AudioCaptureParameters audioCaptureParameters = new AudioCaptureParameters();
}
Since
Available since v3.7.0.

Properties

captureAudio
Note:
  • Due to system limitations, system audio capture is only supported on Android API level 29 and above (Android 10+).
  • To improve the success rate of capturing system audio during screen sharing, make sure to call setAudioScenario and set the audio scenario to AUDIO_SCENARIO_GAME_STREAMING.
Sets whether to capture system audio during screen sharing:
  • true: Capture system audio.
  • false: (Default) Do not capture system audio.
videoCaptureParameters
Video capture parameters for screen sharing video stream. See VideoCaptureParameters.
captureVideo
Note: Due to system limitations, screen capture is only supported on Android API level 21 and above (Android 5+).
Sets whether to capture screen content during screen sharing:
  • true: (Default) Capture screen.
  • false: Do not capture screen.
audioCaptureParameters
Audio capture parameters for screen sharing audio stream. See AudioCaptureParameters.