ScreenCaptureParameters2

Screen sharing configurations.

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);
}

Attributes

captureAudio
Determines whether to capture system audio during screen sharing:
  • true: Capture system audio.
  • false: (Default) Do not capture system audio.
Note:
  • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
  • 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.
audioParams
The audio configuration for the shared screen stream. See ScreenAudioParameters.
Attention: This parameter only takes effect when captureAudio is true.
captureVideo
Whether to capture the screen when screen sharing:
  • true: (Default) Capture the screen.
  • false: Do not capture the screen.
Note: Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.
videoParams
The video configuration for the shared screen stream. See ScreenVideoParameters.
Attention: This parameter only takes effect when captureVideo is true.