ScreenCaptureParameters2

Parameter configuration for screen sharing.

class ScreenCaptureParameters2 {

  const ScreenCaptureParameters2(
      {this.captureAudio,
      this.audioParams,
      this.captureVideo,
      this.videoParams});

  @JsonKey(name: 'captureAudio')
  final bool? captureAudio;

  @JsonKey(name: 'audioParams')
  final ScreenAudioParameters? audioParams;

  @JsonKey(name: 'captureVideo')
  final bool? captureVideo;

  @JsonKey(name: 'videoParams')
  final ScreenVideoParameters? videoParams;

  factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) =>
      _$ScreenCaptureParameters2FromJson(json);

  Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this);
}

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, ensure that you have called 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 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 and above.

Whether to capture the screen during screen sharing:

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

videoParams

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

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