ScreenCaptureParameters2

Used to configure audio and video parameters for screen sharing.

struct ScreenCaptureParameters2 {
  bool captureAudio = false;
  ScreenAudioParameters audioParams;
  bool captureVideo = true;
  ScreenVideoParameters videoParams;
};

Properties

captureAudio

Note: Due to system limitations, system audio capture is only supported on Android API level 29 and above (i.e., Android 10+). To improve the success rate of capturing system audio during screen sharing, ensure that you call the setAudioScenario method and set the audio scenario to AUDIO_SCENARIO_GAME_STREAMING.

Whether to capture system audio during screen sharing:

true: Capture system audio.
false: (default) Do not capture system audio.

audioParams

Audio configuration for the screen sharing stream. See ScreenAudioParameters.

Note: This parameter takes effect only when captureAudio is true.

captureVideo

Note: Due to system limitations, screen capture is only supported on Android API level 21 and above, i.e., Android 5+.

Whether to capture the screen during screen sharing:

true: (default) Capture screen.
false: Do not capture screen.

videoParams

Video configuration for the screen sharing stream. See ScreenVideoParameters.

Note: This parameter takes effect only when captureVideo is true.