ScreenMeetPlugin class

Constructors

ScreenMeetPlugin()
factory

Properties

frameRate ↔ int
Screen sharing frame rate Default is 14fps. For flutter engine this is the optimal fps that works on all devices
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenSharingKey ↔ GlobalKey<State<StatefulWidget>>?
The key of the widget that tis content will be shared during screen sharing
getter/setter pair

Methods

attachConfidentialWidget(String id, RectGetter getter) → void
changeVideoSource() → Future<Map>
Changes the source of the video that you are sharing. Either from camera to screen or vice versa
connect(String roomId, String userName) → Future<Either<ScreenMeetConnectError, bool>>
Connect to the room. Room id is either 6 digits code or 12 letters full room id. userName is your user name that other participants will see
disconnect() → Future<Either<ScreenMeetError, bool>>
getLocalMediaState() → Future<Either<ScreenMeetError, MediaState>>
Responds with your local media state (states of your video, audio, screen sharing)
getLocalVideo() → Future<Either<ScreenMeetError, LocalVideo>>
Responds with your local video. The return object will contain the flag indicating if video is on and textureId for its rendering or -1
getParticipants() → Future<Either<ScreenMeetError, List<Participant>>>
Responds with the list of remote participants on a call
grantAccess(FeatureRequest request) → Future<Either<ScreenMeetError, bool>>
Grant the access to feature
listOfWidgetRects() → List<RectGetter>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rejectAccess(FeatureRequest request) → Future<Either<ScreenMeetError, bool>>
Reject the access to feature
sendScreenShot(ByteData image, List<Rect> rects) → void
setConfidential(String id, double x, double y, double width, double height) → Future<Either<ScreenMeetError, bool>>
Pass the confidential rect to native SDK. This rect will be cut/hidden when sharing video(stream of your screen) with remote participants
setConfig(ScreenMeetConfig config) → Future<Either<ScreenMeetError, bool>>
Sets initial configuration for the ScreenMeet SDK
setConnectionStateListener({dynamic listener(String)?}) → void
Set the listener for connection state of the SDK. Will be fired when room is connected, disconnected, reconnecting, waiting for host to let inm etc
setFeatureRequestListener({dynamic listener(FeatureRequest?, FeatureCancelation?)?}) → void
Set the listener for feature permission requests that SDK receives from remote peers. Will be fired when someone requests access from you to a certain feature (for example remote controlling your screen or showing laser pointer on your screen)
setLocalMediaStateListener({dynamic listener(MediaState)?}) → void
setLocalVideoListener({dynamic listener(LocalVideo)?}) → void
Set the listener for local video itself. Will be fired when video from the camera of your device is started/stopped
setParticipantsListener({dynamic listener(List<Participant>)?}) → void
setRemoteControlListener({dynamic listener(RemoteControlEvent)?}) → void
Set the listener for remote control events sent by SDK. Will be fired when remote control is granted and the participant clicks mouse or keyboard
shareAudio() → Future<Either<ScreenMeetError, bool>>
Start sharing audio from your mic
shareScreen() → Future<Map>
Share the screen of your device
shareScreenWithImageTransfer() → Future<Either<ScreenMeetError, bool>>
Share your screen by continuously providing screenshots of the previewContainerKey renderer
shareVideo(String cameraType) → Future<Either<ScreenMeetError, bool>>
Start sharing video from your camera
solveChallenge(String answer) → Future<Either<ScreenMeetConnectError, bool>>
startCapturingImages() → void
stopAudioSharing() → Future<Either<ScreenMeetError, bool>>
Stop sharing your audio
stopVideoSharing() → Future<Either<ScreenMeetError, bool>>
Stop sharing your video
takeScreenShot() → void
toString() → String
A string representation of this object.
inherited
unsetConfidential(String id) → Future<Either<ScreenMeetError, bool>>
Clear the confidential. This rect will not be cut/hidden when sharing video(stream of your screen) with remote participants

Operators

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