ScreenShareCaptureOptions class

Options used when creating a LocalVideoTrack that captures the screen.

Inheritance

Constructors

ScreenShareCaptureOptions({bool useiOSBroadcastExtension = false, bool captureScreenAudio = false, bool preferCurrentTab = false, String? selfBrowserSurface, String? sourceId, double? maxFrameRate, VideoParameters params = VideoParametersPresets.screenShareH1080FPS15})
const
ScreenShareCaptureOptions.from({bool useiOSBroadcastExtension = false, bool captureScreenAudio = false, bool preferCurrentTab = false, String? selfBrowserSurface, required VideoCaptureOptions captureOptions})

Properties

captureScreenAudio → bool
final
deviceId → String?
The deviceId of the capture device to use. Available deviceIds can be obtained through flutter_webrtc:
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
maxFrameRate → double?
finalinherited
params → VideoParameters
finalinherited
preferCurrentTab → bool
for browser only, if true, will capture current tab.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selfBrowserSurface → String?
for browser only, include or exclude self browser surface.
final
useiOSBroadcastExtension → bool
iOS only flag: Use Broadcast Extension for screen share capturing. See instructions on how to setup your Broadcast Extension here: https://github.com/flutter-webrtc/flutter-webrtc/wiki/iOS-Screen-Sharing#broadcast-extension-quick-setup
final

Methods

copyWith({bool? useiOSBroadcastExtension, bool? captureScreenAudio, VideoParameters? params, String? sourceId, double? maxFrameRate, bool? preferCurrentTab, String? selfBrowserSurface}) → ScreenShareCaptureOptions
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMediaConstraintsMap() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited