ScreenCaptureParameters2

Parameter configuration for screen sharing.

export class ScreenCaptureParameters2 {

  captureAudio?: boolean;
  audioParams?: ScreenAudioParameters;
  captureVideo?: boolean;
  videoParams?: ScreenVideoParameters;
}

Properties

captureAudio

Note:

Due to system limitations, capturing system audio is only supported on Android API level 29 and above, i.e., Android 10 and above.
To improve the success rate of capturing system audio during screen sharing, make sure you call the setAudioScenario method and set the audio scenario to AudioScenarioGameStreaming.

Whether to capture system audio during screen sharing:

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

audioParams

Audio configuration for the shared screen stream. See ScreenAudioParameters.

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

captureVideo

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

Whether to capture the screen during screen sharing:

true: (Default) Capture the screen.
false: Do not capture the screen.

videoParams

Video encoding configuration for the shared screen stream. See ScreenVideoParameters.

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