CheckScreenShareParameters class abstract

Parameters for checking screen sharing status and managing screen share actions.

Contains properties to track the screen share state, alert functions, whiteboard and breakout room status, and functions to start or stop screen sharing.

Implemented types
Implementers

Properties

activeNames → List<String>
no setterinherited
activeSounds → List<String>
no setterinherited
addVideosGrid → AddVideosGridType
no setterinherited
adminIDStream → String
no setterinherited
adminNameStream → String
no setterinherited
adminOnMainScreen → bool
no setterinherited
adminVidID → String
no setterinherited
allAudioStreams → List<Stream>
no setterinherited
allVideoStreams → List<Stream>
no setterinherited
annotateScreenStream → bool
no setterinherited
aParams → ProducerOptionsType?
no setterinherited
appliedBackground → bool
Whether a virtual background has been applied
no setterinherited
audioAlreadyOn → bool
no setterinherited
audioDecibels → List<AudioDecibels>
no setterinherited
audioParams → ProducerOptionsType?
no setterinherited
audioProducer → Producer?
no setterinherited
audStreamNames → List<Stream>
no setterinherited
autoAdjust → AutoAdjustType
no setterinherited
breakOutRoomEnded → bool
no setteroverride
breakoutRooms → List<List<BreakoutParticipant>>
no setterinherited
breakOutRoomStarted → bool
no setteroverride
calculateRowsAndColumns → CalculateRowsAndColumnsType
no setterinherited
canvasStream → MediaStream?
no setterinherited
changeVids → ChangeVidsType
no setterinherited
chatRefStreams → List<Stream>
no setterinherited
checkGrid → CheckGridType
no setterinherited
checkOrientation → String Function()
no setterinherited
coHost → String
no setterinherited
coHostResponsibility → List<CoHostResponsibility>
no setterinherited
compareActiveNames → CompareActiveNamesType
no setterinherited
compareScreenStates → CompareScreenStatesType
no setterinherited
componentSizes → ComponentSizes
no setterinherited
connectSendTransport → ConnectSendTransportType
no setterinherited
connectSendTransportAudio → ConnectSendTransportAudioType
no setterinherited
connectSendTransportScreen → ConnectSendTransportScreenType
no setterinherited
connectSendTransportVideo → ConnectSendTransportVideoType
no setterinherited
consumerTransports → List<TransportType>
no setterinherited
createSendTransport → CreateSendTransportType
no setterinherited
currentUserPage → int
no setterinherited
customAudioCard → AudioCardType?
no setterinherited
customMiniCard → MiniCardType?
no setterinherited
customVideoCard → VideoCardType?
no setterinherited
defAudioID → String
no setterinherited
deferReceive → bool
no setterinherited
device → Device?
no setterinherited
disconnectSendTransportScreen → DisconnectSendTransportScreenType
no setterinherited
dispActiveNames → List<String>
no setterinherited
dispStreams → DispStreamsType
no setterinherited
doPaginate → bool
no setterinherited
eventType → EventType
no setterinherited
firstAll → bool
no setterinherited
firstRound → bool
no setterinherited
fixedPageLimit → int
no setterinherited
forceFullDisplay → bool
no setterinherited
getEstimate → GetEstimateType
no setterinherited
getUpdatedAllParams → RequestScreenShareParameters Function()
no setterinherited
getVideos → GetVideosType
no setterinherited
gridSizes → GridSizes
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hostLabel → String
no setterinherited
hostNewRoom → int
no setterinherited
isDarkModeValue → bool
no setterinherited
islevel → String
no setterinherited
isMediumScreen → bool
no setterinherited
isWideScreen → bool
no setterinherited
itemPageLimit → int
no setterinherited
keepBackground → bool
no setterinherited
lastUpdate → int?
no setterinherited
limitedBreakRoom → List<BreakoutParticipant>
no setterinherited
liveSubtitles → ValueListenable<Map<String, LiveSubtitle>>
Per-speaker live subtitle data: Map&lt;speakerId, LiveSubtitle&gt;
no setterinherited
localAudioProducer → Producer?
no setterinherited
localProducerTransport → Transport?
no setterinherited
localScreenProducer → Producer?
no setterinherited
localSocket → Socket?
no setterinherited
localStream → MediaStream?
no setterinherited
localStreamAudio → MediaStream?
no setterinherited
localStreamScreen → MediaStream?
no setterinherited
localStreamVideo → MediaStream?
The local video stream (needed for BackgroundVideoDisplay)
no setterinherited
localTransportCreated → bool?
no setterinherited
localUIMode → bool
no setterinherited
localVideoProducer → Producer?
no setterinherited
lockScreen → bool
no setterinherited
mainHeightWidth → double
no setterinherited
mainRoomsLength → int
no setterinherited
mainScreenFilled → bool
no setterinherited
mainScreenPerson → String
no setterinherited
meetingDisplayType → String
no setterinherited
meetingVideoOptimized → bool
no setterinherited
member → String
no setterinherited
memberRoom → int
no setterinherited
micAction → bool
no setterinherited
mixedAlVideoStreams → List<Stream>
no setterinherited
mixStreams → MixStreamsType
no setterinherited
newLimitedStreams → List<Stream>
no setterinherited
newLimitedStreamsIDs → List<String>
no setterinherited
nForReadjust → int?
no setterinherited
nForReadjustRecord → int
no setterinherited
nonAlVideoStreams → List<Stream>
no setterinherited
nonAlVideoStreamsMuted → List<Stream>
no setterinherited
oldAllStreams → List<Stream>
no setterinherited
onWeb → bool
no setterinherited
otherGridStreams → List<List<Widget>>
no setterinherited
pActiveNames → List<String>
no setterinherited
paginatedStreams → List<List<Stream>>
no setterinherited
paginationDirection → String
no setterinherited
paginationHeightWidth → double
no setterinherited
panelists → List<Participant>
no setterinherited
panelistsFocused → bool
no setterinherited
params → ProducerOptionsType?
no setterinherited
participants → List<Participant>
no setterinherited
pDispActiveNames → List<String>
no setterinherited
prepopulateUserMedia → PrepopulateUserMediaType
no setterinherited
prevActiveNames → List<String>
no setterinherited
prevDoPaginate → bool
no setterinherited
prevForceFullDisplay → bool
no setterinherited
prevMainHeightWidth → double
no setterinherited
prevScreenStates → List<ScreenState>
no setterinherited
processConsumerTransports → ProcessConsumerTransportsType
no setterinherited
processConsumerTransportsAudio → ProcessConsumerTransportsAudioType
no setterinherited
producerTransport → Transport?
no setterinherited
readjust → ReadjustType
no setterinherited
recordingDisplayType → String
no setterinherited
recordingVideoOptimized → bool
no setterinherited
recordPaused → bool
no setterinherited
recordResumed → bool
no setterinherited
recordStarted → bool
no setterinherited
recordStopped → bool
no setterinherited
refParticipants → List<Participant>
no setterinherited
remoteScreenStream → List<Stream>
no setterinherited
removeAltGrid → bool
no setterinherited
reorderStreams → ReorderStreamsType
no setterinherited
rePort → RePortType
no setterinherited
requestScreenShare → RequestScreenShareType
no setter
resumePauseAudioStreams → ResumePauseAudioStreamsType
no setterinherited
resumePauseStreams → ResumePauseStreamsType
no setterinherited
resumeSendTransportAudio → ResumeSendTransportAudioType
no setterinherited
roomName → String
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenAction → bool
no setterinherited
screenAlreadyOn → bool
no setterinherited
screenForceFullDisplay → bool
no setterinherited
screenId → String
no setterinherited
screenPageLimit → int
no setterinherited
screenParams → ProducerOptionsType?
no setterinherited
screenProducer → Producer?
no setterinherited
screenShareIDStream → String
no setterinherited
screenShareNameStream → String
no setterinherited
screenStates → List<ScreenState>
no setterinherited
selfViewForceFull → bool
no setterinherited
shared → bool
no setteroverride
shareEnded → bool
no setterinherited
shareScreenStarted → bool
no setterinherited
showAlert → ShowAlert?
no setteroverride
showSubtitlesOnCards → bool
Whether to show subtitles on video cards
no setterinherited
showSubtitlesOnCardsNotifier → ValueListenable<bool>?
Reactive notifier for whether to show subtitles on cards
no setterinherited
sleep → SleepType
no setterinherited
socket → Socket?
no setterinherited
sortAudioLoudness → bool
no setterinherited
startShareScreen → StartShareScreenType
no setterinherited
stopShareScreen → StopShareScreenType
no setteroverride
streamNames → List<Stream>
no setterinherited
streamSuccessScreen → StreamSuccessScreenType
no setterinherited
targetResolution → String
no setterinherited
targetResolutionHost → String
no setterinherited
transportCreated → bool
no setterinherited
transportCreatedAudio → bool
no setterinherited
transportCreatedScreen → bool
no setterinherited
trigger → TriggerType
no setterinherited
updateActiveNames → void Function(List<String> activeNames)
no setterinherited
updateActiveSounds → void Function(List<String> activeNames)
no setterinherited
updateAddAltGrid → UpdateAddAltGrid
no setterinherited
updateAdminIDStream → void Function(String id)
no setterinherited
updateAdminNameStream → void Function(String id)
no setterinherited
updateAdminOnMainScreen → UpdateAddAltGrid
no setterinherited
updateAllVideoStreams → void Function(List<Stream>)
no setterinherited
updateAltGridCols → void Function(int)
no setterinherited
updateAltGridRows → void Function(int)
no setterinherited
updateAnnotateScreenStream → UpdateAddAltGrid
no setterinherited
updateAudioAlreadyOn → UpdateAddAltGrid
no setterinherited
updateAudioLevel → void Function(double audioLevel)
no setterinherited
updateAudioParams → void Function(ProducerOptionsType audioParams)
no setterinherited
updateAudioProducer → UpdateAudioProducer
no setterinherited
updateChatRefStreams → void Function(List<Stream>)
no setterinherited
updateCurrentUserPage → void Function(int)
no setterinherited
updateDateState → int?
no setterinherited
updateDefAudioID → void Function(String id)
no setterinherited
updateDeferReceive → UpdateAddAltGrid
no setterinherited
updateDispActiveNames → void Function(List<String> activeNames)
no setterinherited
updateDoPaginate → UpdateAddAltGrid
no setterinherited
updateFirstAll → UpdateAddAltGrid
no setterinherited
updateFirstRound → UpdateAddAltGrid
no setterinherited
updateForceFullDisplay → UpdateAddAltGrid
no setterinherited
updateGridCols → void Function(int)
no setterinherited
updateGridRows → void Function(int)
no setterinherited
updateGridSizes → void Function(GridSizes)
no setterinherited
updateIsScreenboardModalVisible → UpdateAddAltGrid
no setterinherited
updateLastUpdate → void Function(int? lastUpdate)
no setterinherited
updateLimitedBreakRoom → void Function(List<BreakoutParticipant>)
no setterinherited
updateLocalAudioProducer → void Function(Producer? producer)?
no setterinherited
updateLocalProducerTransport → UpdateProducerTransport?
no setterinherited
updateLocalScreenProducer → void Function(Producer? producer)?
no setterinherited
updateLocalStream → void Function(MediaStream? localStream)
no setterinherited
updateLocalStreamAudio → void Function(MediaStream? localStream)
no setterinherited
updateLocalStreamScreen → void Function(MediaStream? localStream)
no setterinherited
updateLocalStreamVideo → void Function(MediaStream? localStream)
no setterinherited
updateLocalTransportCreated → UpdateTransportCreated?
no setterinherited
updateLocalVideoProducer → void Function(Producer? producer)?
no setterinherited
updateLockScreen → UpdateAddAltGrid
no setterinherited
updateLStreams → void Function(List<Stream>)
no setterinherited
updateMainGridStream → void Function(List<Widget>)
no setterinherited
updateMainHeightWidth → void Function(double audioLevel)
no setterinherited
updateMainRoomsLength → void Function(int)
no setterinherited
updateMainScreenFilled → UpdateAddAltGrid
no setterinherited
updateMainScreenPerson → void Function(String id)
no setterinherited
updateMainWindow → bool
no setterinherited
updateMemberRoom → void Function(int)
no setterinherited
updateMicAction → UpdateAddAltGrid
no setterinherited
updateMiniCardsGrid → UpdateMiniCardsGridType
no setterinherited
updateMixedAlVideoStreams → void Function(List<Stream>)
no setterinherited
updateNewLimitedStreams → void Function(List<Stream>)
no setterinherited
updateNewLimitedStreamsIDs → void Function(List<String> activeNames)
no setterinherited
updateNForReadjust → void Function(int)
no setterinherited
updateNForReadjustRecord → void Function(int)
no setterinherited
updateNonAlVideoStreams → void Function(List<Stream>)
no setterinherited
updateNonAlVideoStreamsMuted → void Function(List<Stream>)
no setterinherited
updateNumberPages → void Function(int)
no setterinherited
updateOldAllStreams → void Function(List<Stream>)
no setterinherited
updateOtherGridStreams → UpdateOtherGridStreams
no setterinherited
updatePActiveNames → void Function(List<String> activeNames)
no setterinherited
updatePaginatedStreams → void Function(List<List<Stream>> paginatedStreams)
no setterinherited
updateParticipants → void Function(List<Participant> participants)
no setterinherited
updatePrevActiveNames → void Function(List<String> activeNames)
no setterinherited
updatePrevDoPaginate → UpdateAddAltGrid
no setterinherited
updatePrevScreenStates → void Function(List<ScreenState>)
no setterinherited
updateProducerTransport → UpdateProducerTransport
no setterinherited
updateRefParticipants → void Function(List<Participant> participants)
no setterinherited
updateRemoveAltGrid → UpdateAddAltGrid
no setterinherited
updateScreenAction → UpdateAddAltGrid
no setterinherited
updateScreenAlreadyOn → UpdateAddAltGrid
no setterinherited
updateScreenForceFullDisplay → UpdateAddAltGrid
no setterinherited
updateScreenProducer → UpdateAudioProducer
no setterinherited
updateScreenShareIDStream → void Function(String id)
no setterinherited
updateScreenShareNameStream → void Function(String id)
no setterinherited
updateScreenStates → void Function(List<ScreenState>)
no setterinherited
updateSelfViewForceFull → UpdateAddAltGrid
no setterinherited
updateShareEnded → UpdateAddAltGrid
no setterinherited
updateShareScreenStarted → UpdateAddAltGrid
no setterinherited
updateShowMiniView → UpdateAddAltGrid
no setterinherited
updateSortAudioLoudness → UpdateAddAltGrid
no setterinherited
updateTransportCreated → UpdateAddAltGrid
no setterinherited
updateTransportCreatedAudio → UpdateAddAltGrid
no setterinherited
updateTransportCreatedScreen → UpdateAddAltGrid
no setterinherited
updateUpdateDateState → void Function(int? lastUpdate)
no setterinherited
updateUpdateMainWindow → UpdateAddAltGrid
no setterinherited
updateUserDefaultAudioInputDevice → void Function(String id)
no setterinherited
updateVideoProducer → UpdateAudioProducer
no setterinherited
updateYouYouStream → void Function(List<Stream>)
no setterinherited
userDefaultAudioInputDevice → String
no setterinherited
videoAlreadyOn → bool
no setterinherited
videoParams → ProducerOptionsType?
no setterinherited
videoProducer → Producer?
no setterinherited
virtualStream → MediaStream?
no setterinherited
whiteboardEnded → bool
no setteroverride
whiteboardStarted → bool
no setteroverride

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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