types\types library

Classes

AddVideosGridOptions: Options for adding participants and streams to the video grid.
AddVideosGridParameters: Parameters for adding videos to the grid, extending functionality from update mini-cards and audio card parameters.
AlertComponent: AlertComponent - A widget for displaying alerts with customizable options.
AlertComponentOptions: AlertComponentOptions - Configuration options for the AlertComponent widget.
AllMembersData
AllMembersOptions: Options for managing all members.
AllMembersParameters: Defines parameters for managing all members.
AllMembersRestData
AllMembersRestOptions: Options required for handling all members in the room.
AllMembersRestParameters: Contains all parameters required for handling member updates and configurations in the room.
AllWaitingRoomMembersData
AllWaitingRoomMembersOptions: Defines options for managing all waiting room members.
AltButton: AltButton - Represents a configurable button within the control button component.
AltDomains
AudioCard: AudioCard - A card widget for displaying audio-related information and controls for a participant.
AudioCardOptions: AudioCardOptions - Configuration options for the AudioCard widget.
AudioCardParameters: AudioCardParameters - Abstract class defining parameters required for the AudioCard widget.
AudioData
AudioDecibels
AudioGrid: A layout widget to stack multiple audio components on top of each other using AudioGridOptions.
AudioGridOptions: Configuration options for the AudioGrid widget.
AutoAdjustOptions: Options for adjusting values based on various parameters.
BanData
BanParticipantOptions: Options for banning a participant, including their name and the required parameters.
BanParticipantParameters: Parameters for banning a participant, extending ReorderStreamsParameters and including properties like active and display names, participants, and update and reorder functions.
BreakoutParticipant
BreakoutRoomsModal: A modal widget for managing breakout rooms within a meeting. Allows users to create, edit, and delete rooms, assign participants, and start breakout rooms.
BreakoutRoomsModalOptions: Options for configuring the BreakoutRoomsModal widget.
BreakoutRoomsModalParameters: Parameters for managing breakout rooms within a meeting.
BreakoutRoomUpdatedData
BreakoutRoomUpdatedOptions
BreakoutRoomUpdatedParameters
ButtonTouch: ButtonTouch - Represents a control button with customizable style and behavior.
CalculateRowsAndColumnsOptions: Options for calculating the number of rows and columns in a grid layout.
CaptureCanvasStreamOptions
CaptureCanvasStreamParameters
CardVideoDisplay: CardVideoDisplay - A widget to display video streams in a card format based on CardVideoDisplayOptions.
CardVideoDisplayOptions: CardVideoDisplayOptions - Configuration options for the CardVideoDisplay widget.
ChangeVidsOptions
ChangeVidsParameters: Parameters used for changing video streams based on various conditions.
CheckGridOptions: Options for checking the grid configuration.
CheckLimitsAndMakeRequestOptions: CheckLimitsAndMakeRequestOptions
CheckPauseStateOptions: Defines options for checking the pause state.
CheckPermissionOptions: Options for checking permission based on specific settings.
CheckResumeStateOptions: Options for checking if recording can be resumed.
CheckScreenShareOptions: Options for the checkScreenShare function.
CheckScreenShareParameters: Parameters for checking screen sharing status and managing screen share actions.
ClickAudioOptions
ClickAudioParameters
ClickChatOptions: Parameters for the clickChat function.
ClickScreenShareOptions: Options for handling screen share actions.
ClickScreenShareParameters
ClickVideoOptions
ClickVideoParameters
CloseAndResizeOptions
CloseAndResizeParameters
CoHostModal: CoHostModal - A modal widget for managing co-host settings.
CoHostModalOptions: Configuration options for the CoHostModal widget.
CoHostResponsibility
CompareActiveNamesOptions: Options interface for comparing active names.
CompareActiveNamesParameters: Parameters interface for comparing active names.
CompareScreenStatesOptions: Options for comparing screen states.
CompareScreenStatesParameters: Parameters for comparing screen states.
ComponentSizes
ConfirmExitModal: ConfirmExitModalOptions - Configuration options for ConfirmExitModal.
ConfirmExitModalOptions: ConfirmExitModalOptions - Defines configuration options for the ConfirmExitModal.
ConfirmExitOptions: Defines the options for confirming the exit of a member from a room.
ConfirmHereModal: ConfirmHereModal prompts the user to confirm presence with a countdown timer and action button.
ConfirmHereModalOptions: ConfirmHereModalOptions defines the configuration for ConfirmHereModal, including visibility, callbacks, countdown, and socket settings.
ConfirmRecordingOptions: Class encapsulating options for confirming recording.
ConfirmRecordingParameters: Class for recording parameters used in confirming recording settings.
ConnectIpsOptions: Options for connecting IPs and managing socket connections.
ConnectIpsParameters: Parameters interface for connecting IPs and managing socket connections.
ConnectLocalIpsOptions: Options for connecting local IPs and managing socket connections.
ConnectLocalIpsParameters: Parameters interface for connecting local IPs and managing socket connections.
ConnectLocalSocketOptions: Options for connecting to a local socket.
ConnectRecvTransportOptions: Options for connecting the receiving transport.
ConnectRecvTransportParameters: Parameters for connecting the receiving transport.
ConnectSendTransportAudioOptions
ConnectSendTransportAudioParameters
ConnectSendTransportOptions
ConnectSendTransportParameters
ConnectSendTransportScreenOptions
ConnectSendTransportScreenParameters
ConnectSendTransportVideoOptions
ConnectSendTransportVideoParameters
ConnectSocketOptions: Options for connecting to a socket.
ConsumeResponse
ConsumerResumeOptions: Configuration options for the consumerResume function, used to manage the resumption of audio or video streams.
ConsumerResumeParameters: Abstract class defining parameters for handling the resumption of audio and video streams in a media session.
ControlButton: ControlButton - A model class to define properties of individual control buttons.
ControlButtonsAltComponent: ControlButtonsAltComponent - A widget that displays a configurable set of control buttons with flexible styling and alignment options.
ControlButtonsAltComponentOptions: ControlButtonsAltComponentOptions - Configures settings for the ControlButtonsAltComponent.
ControlButtonsComponent: ControlButtonsComponent - A widget that displays a set of control buttons based on specified options.
ControlButtonsComponentOptions: ControlButtonsComponentOptions - Configuration options for the ControlButtonsComponent.
ControlButtonsComponentTouch: ControlButtonsComponentTouch - Renders a customizable set of control buttons.
ControlButtonsComponentTouchOptions: ControlButtonsComponentTouchOptions - Configuration options for ControlButtonsComponentTouch.
ControlMediaHostData
ControlMediaHostOptions: Defines the options needed for controlling media actions on the host side.
ControlMediaHostParameters: Defines parameters for controlling media host actions in a meeting or room.
ControlMediaOptions: Represents the options for controlling media in a room.
CreateDeviceClientOptions: Options for creating a mediasoup client device.
CreateJoinLocalRoomResponse
CreateJoinRoomError: CreateJoinRoomError
CreateJoinRoomResponse: CreateJoinRoomResponse
CreateJoinRoomResult: CreateJoinRoomResult
CreateLocalRoomOptions
CreateLocalRoomParameters
CreateMediaSFUOptions
CreateMediaSFURoomOptions
CreateRoomOptions
CreateSendTransportOptions
CreateSendTransportParameters
CreateWebRTCTransportResponse
Credentials
CustomButton: CustomButton - Defines options for each button within the CustomButtons widget.
CustomButtons: CustomButtons - A widget to display a list of customizable buttons.
CustomButtonsOptions: CustomButtonsOptions - Defines configuration options for multiple buttons in CustomButtons.
DataBufferNotice
DimensionConstraints
DisconnectOptions: Options for disconnecting the user from the session.
DisconnectSendTransportAudioOptions: Represents the options required to disconnect the audio send transport.
DisconnectSendTransportAudioParameters: Represents the parameters required to disconnect the audio send transport.
DisconnectSendTransportScreenOptions: Represents the options required to disconnect the screen send transport.
DisconnectSendTransportScreenParameters: Dart equivalent of DisconnectSendTransportScreenParameters interface
DisconnectSendTransportVideoOptions: Represents the options required to disconnect the video send transport.
DisconnectSendTransportVideoParameters: Callback types/// Represents the parameters required to disconnect the video send transport.
DisconnectSocketOptions
DisconnectUserSelfOptions: Options for disconnecting the user (self) from a specified room.
DisplaySettingsModal: DisplaySettingsModalOptions - Configuration options for the DisplaySettingsModal.
DisplaySettingsModalOptions: DisplaySettingsModalOptions - Configuration options for the DisplaySettingsModal.
DisplaySettingsModalParameters
DispSpecs
DispStreamsOptions: Options for the dispStreams function.
DispStreamsParameters: Parameters required for displaying streams. Extends multiple parameter interfaces from your TypeScript definitions.
EditRoomModal: Modal widget for editing breakout room participants.
EditRoomModalOptions: Options for configuring the EditRoomModal widget.
EventSettingsModal: EventSettingsModalOptions - Configuration options for EventSettingsModal.
EventSettingsModalOptions: EventSettingsModalOptions - Defines configuration options for the EventSettingsModal.
FlexibleGrid: FlexibleGrid - A widget that displays a flexible grid layout based on specified rows and columns.
FlexibleGridOptions: FlexibleGridOptions - Configuration options for the FlexibleGrid widget.
FlexibleVideo: FlexibleVideo - A widget that displays a customizable video container.
FlexibleVideoOptions: FlexibleVideoOptions - Configuration options for the FlexibleVideo widget.
FormatNumberOptions: Options for the formatNumber function.
GeneratePageContentOptions: Options for generating page content.
GeneratePageContentParameters: Parameters used for generating page content for a specific user interface page.
GenerateRandomMessagesOptions: Options for generating random messages.
GenerateRandomParticipantsOptions: Options for generating a random list of participants.
GenerateRandomPollsOptions: Class to hold options for generating a random poll list.
GenerateRandomRequestListOptions: Class to hold options for generating a random request list.
GetDomainsOptions: Options for retrieving domains and processing connections.
GetDomainsParameters: Parameters required for the getDomains function.
GetEstimateOptions
GetEstimateParameters: Parameters for estimating rows and columns based on given configurations.
GetModalPositionOptions: Options for configuring the modal position.
GetOverlayPositionOptions: Options for configuring the overlay position.
GetPipedProducersAltOptions: Options for retrieving piped producers.
GetPipedProducersAltParameters: Parameters for signaling new consumer transport.
GetProducersPipedOptions: Options for retrieving piped producers.
GetProducersPipedParameters: Parameters for signaling new consumer transport.
GetVideosOptions: Options for retrieving and processing video streams.
GridSizes
HandleCreatePollOptions: Defines options for creating a poll in a room.
HandleEndPollOptions: Defines options for handling the end of a poll.
HandleVotePollOptions: Defines options for handling a poll vote.
HostRequestResponseData
HostRequestResponseOptions: Defines options for handling a host's response to a participant request.
ImageData
JoinConRoomOptions: Options for joining a conference room.
JoinConsumeRoomOptions: Options for the joinConsumeRoom function.
JoinConsumeRoomParameters: Interface for parameters required by the joinConsumeRoom function.
JoinLocalEventRoomOptions
JoinLocalEventRoomParameters
JoinMediaSFUOptions
JoinMediaSFURoomOptions
JoinRoomClientOptions: Represents options for joining a room client.
JoinRoomOptions: Options for joining a room.
LaunchBackgroundOptions
LaunchBreakoutRoomsOptions: Defines options for launching breakout rooms, including the function to update visibility and the current modal visibility state.
LaunchCoHostOptions: Defines options for launching the co-host modal, including the function to update visibility and the current modal visibility state.
LaunchConfigureWhiteboardOptions
LaunchConfirmExitOptions: Defines the options for toggling the confirmation exit modal visibility.
LaunchDisplaySettingsOptions: Defines options for launching the display settings modal, including the function to update visibility and the current modal visibility state.
LaunchMediaSettingsOptions: Defines options for launching the media settings modal, including visibility toggling, available audio/video devices, and update functions.
LaunchMenuModalOptions: Defines options for toggling the visibility of the menu modal.
LaunchMessagesOptions: Defines options for toggling the visibility of the messages modal.
LaunchParticipantsOptions: Defines options for launching the participants modal.
LaunchPollOptions: Defines options for toggling the poll modal visibility.
LaunchRecordingOptions: Options for launching a recording.
LaunchRequestsOptions: Parameters for launching requests in the app.
LaunchSettingsOptions: Options for launching the settings modal.
LaunchWaitingOptions: Options for launching the waiting modal
LoadingModal: LoadingModal - A loading modal overlay widget.
LoadingModalOptions: LoadingModalOptions - Configuration options for the LoadingModal widget.
MainAspectComponent: MainAspectComponent - A responsive component adjusting dimensions based on screen size and optional controls.
MainAspectComponentOptions: MainAspectComponentOptions - Configuration options for the MainAspectComponent.
MainContainerComponent: MainContainerComponent - A container widget with customizable dimensions, margins, and background color.
MainContainerComponentOptions: MainContainerComponentOptions - Configuration options for MainContainerComponent.
MainGridComponent: MainGridComponent - A flexible grid component with customizable layout, child widgets, and background color.
MainGridComponentOptions: MainGridComponentOptions - Configuration options for the MainGridComponent.
MainScreenComponent: MainScreenComponent - A flexible layout widget for creating main screens with adjustable layout and size.
MainScreenComponentOptions: MainScreenComponentOptions - Configuration options for the MainScreenComponent widget.
MainSpecs
MediaSettingsModal: MediaSettingsModalOptions - Configuration options for the MediaSettingsModal.
MediaSettingsModalOptions: MediaSettingsModalOptions - Defines configuration options for the MediaSettingsModal.
MediaSettingsModalParameters: MediaSettingsModalParameters - Abstract class defining required parameters for configuring media settings.
MediasfuBroadcast: MediasfuBroadcast - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuBroadcastOptions
MediasfuChat: MediasfuChat - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuChatOptions
MediasfuConference: MediasfuConference - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuConferenceOptions
MediasfuGeneric: MediasfuGeneric - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuGenericOptions
MediasfuParameters
MediasfuWebinar: MediasfuWebinar - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuWebinarOptions
MeetingEndedOptions: Defines options for handling the end of a meeting.
MeetingProgressTimer: MeetingProgressTimer - A widget that displays the meeting progress time with customizable style and position.
MeetingProgressTimerOptions: MeetingProgressTimerOptions - Configuration options for the MeetingProgressTimer.
MeetingRoomParams
MeetingStillThereData
MeetingStillThereOptions: Defines options for handling the "still there?" check in a meeting.
MeetingTimeRemainingData
MeetingTimeRemainingOptions: Defines options for handling meeting time remaining.
MenuModal: MenuModalOptions - Configuration options for the MenuModal widget.
MenuModalOptions: Options class for configuring the MenuModal widget.
Message
MessageParticipantsOptions: Defines options for messaging a participant.
MessagesModal: MessagesModal displays a modal interface for managing direct and group messages within an event. It provides separate tabs for viewing and sending direct or group messages, configurable based on the event type.
MessagesModalOptions
MiniAudio: MiniAudio - A widget that displays a mini audio card with customizable audio information.
MiniAudioOptions: MiniAudioOptions - Configuration options for the MiniAudio widget.
MiniAudioPlayer: A Flutter widget for playing audio streams with optional waveform visualization.
MiniAudioPlayerOptions: Options for MiniAudioPlayer.
MiniAudioPlayerParameters: Parameters for MiniAudioPlayer.
MiniCard: MiniCard - A Flutter widget for displaying a mini card with initials or an image.
MiniCardOptions: MiniCardOptions - Configuration options for the MiniCard.
MixStreamsOptions: Parameters for mixing video and audio streams with participants.
ModalPositionStyle
ModifyCoHostSettingsOptions: Defines the options for modifying co-host settings.
ModifyDisplaySettingsOptions
ModifyDisplaySettingsParameters: Parameters for modifying display settings, including functions and states.
ModifySettingsOptions: Options for modifying room settings.
MuteParticipantsOptions: Defines options for muting a participant in a room.
NewPipeProducerOptions: Options for the newPipeProducer function.
NewPipeProducerParameters: Interface for NewPipeProducerParameters, extending other parameters.
OnScreenChangesOptions: Options for handling screen changes.
OnScreenChangesParameters: Parameters for handling screen changes.
OtherGridComponent: OtherGridComponent - A widget for displaying a grid with customizable background color, children, and optional timer.
OtherGridComponentOptions: OtherGridComponentOptions - Configuration options for the OtherGridComponent.
OverlayPositionStyle
Pagination: Pagination - A widget for handling pagination with breakout room considerations.
PaginationOptions: PaginationOptions - Configuration options for the Pagination widget.
PaginationParameters
Participant
ParticipantRequestedData
ParticipantRequestedOptions
ParticipantsModal: ParticipantsModal is a widget that displays a modal for managing participants in an event. It allows users to filter, mute, message, or remove participants depending on their permissions.
ParticipantsModalOptions
ParticipantsModalParameters
PersonJoinedOptions: Options for handling the event when a person joins.
Poll
PollModal: PollModal is a modal widget that provides an interface for creating, viewing, and managing polls in a real-time environment with socket-based communication.
PollModalOptions
PollUpdatedData
PollUpdatedOptions: Defines options for updating poll information.
PreJoinPage: PreJoinPage
PreJoinPageOptions
PreJoinPageParameters
PrepopulateUserMediaOptions: Configuration options for the prepopulateUserMedia function. This function populates the main media grid with video, audio, or mini-cards based on the media activity of the participant. It dynamically updates the main media grid based on the EventType and participant settings. The function returns a list of widgets representing the media display or an empty list for inactive states. It also catches errors during the media card setup and provides debugging messages in development mode.
PrepopulateUserMediaParameters: Parameters for the prepopulateUserMedia function, implementing multiple interfaces to support flexible and detailed media grid configurations for participants.
ProcessConsumerTransportsAudioOptions
ProcessConsumerTransportsAudioParameters
ProcessConsumerTransportsOptions
ProcessConsumerTransportsParameters
ProducerClosedOptions: Options for the producerClosed function.
ProducerClosedParameters: Abstract class representing the parameters needed for the producerClosed function.
ProducerMediaClosedData
ProducerMediaClosedOptions: Class representing options for closing a producer's media.
ProducerMediaClosedParameters: Abstract class defining the parameters required for closing media of a producer.
ProducerMediaPausedData
ProducerMediaPausedOptions: Encapsulates the options for pausing a producer's media.
ProducerMediaPausedParameters: Defines the parameters required for pausing media of a producer.
ProducerMediaResumedData
ProducerMediaResumedOptions
ProducerMediaResumedParameters
ProducerOptionsType
ReadjustOptions
ReadjustParameters
ReceiveAllPipedTransportsOptions
ReceiveAllPipedTransportsParameters: Parameters for receiving all piped transports
ReceiveMessageData
ReceiveMessageOptions: Represents options for receiving and processing a message.
RecordingModal: RecordingModal widget is used to display recording options, enabling users to confirm, customize, and start recordings with interactive controls and settings panels.
RecordingModalOptions: Configuration options for displaying and managing the RecordingModal. The options include visibility, position, background color, and functions for confirming and starting recordings. The options also include parameters for recording customization and settings. The RecordingModal widget uses these options to display the modal and manage recording actions and settings.
RecordingModalParameters: Abstract class RecordingModalParameters defines recording configuration parameters and provides abstract getters for settings like video type, display type, background color, and additional properties for recording customization.
RecordingNoticeData
RecordingNoticeOptions
RecordingNoticeParameters
RecordingParams
RecordParameters
RecordParams: Represents the recording parameters to be updated.
RecordPauseTimerOptions: Options for controlling the recording timer, allowing pause and resume actions.
RecordResumeTimerOptions: Options for the recordResumeTimer function.
RecordResumeTimerParameters: Parameters for resuming the recording timer.
RecordStartTimerOptions: Options for initiating the recording timer.
RecordStartTimerParameters: Parameters required for the recording timer.
RecordUpdateTimerOptions: Options required for updating the record timer.
ReInitiateRecordingOptions: Options for re-initiating recording, including room details, the member initiating the recording, the socket connection to the server, and an optional admin restriction setting.
RemoveParticipantsOptions: Defines options for removing a participant from a room.
ReorderStreamsOptions
ReorderStreamsParameters
RePortOptions
RePortParameters
Request
RequestResponse
RequestScreenShareOptions
RequestScreenShareParameters
RequestsModal: RequestsModal displays a modal window containing a list of requests and provides search and filter functionality. The modal allows users to accept or reject each request using real-time actions through a socket connection.
RequestsModalOptions: Options for the RequestsModal widget.
RequestsModalParameters
RespondToRequestsOptions: Defines the options for responding to requests.
RespondToWaitingOptions: Options for responding to a waiting participant.
ResponseJoinLocalRoom
ResponseJoinRoom
ResponseLocalConnection: Response for local socket connection.
ResponseLocalConnectionData: Data received during local socket connection.
ResumePauseAudioStreamsOptions
ResumePauseAudioStreamsParameters
ResumePauseStreamsOptions
ResumePauseStreamsParameters
ResumeSendTransportAudioOptions
ResumeSendTransportAudioParameters
ReUpdateInterOptions
ReUpdateInterParameters
RoomList: A widget for displaying a list of breakout rooms and managing participants.
RoomOptions: Configuration options for managing a room's participant list, edit, and delete actions.
RoomRecordParamsOptions: Options to configure the recording parameter updates.
RoomRecordParamsParameters: Defines update functions for each recording parameter.
SafeRoomNoticeData
ScreenProducerIdData
ScreenProducerIdOptions: Options for managing and updating screen sharing based on the producer ID.
ScreenState
SeedData
SendMessageOptions: Defines options for sending a message to a room.
Settings
ShapePayload
Shapes
ShareEventModal: ShareEventModal is a modal widget that allows users to share event details, copy meeting ID and passcode, and interact with sharing buttons.
ShareEventModalOptions: ShareEventModalOptions defines the properties for the ShareEventModal, including visibility, callbacks, and event data.
ShowAlertOptions
SignalNewConsumerTransportOptions: Options required for signaling a new consumer transport.
SignalNewConsumerTransportParameters: Parameters required for signaling a new consumer transport. Extends ReorderStreamsParameters and ConnectRecvTransportParameters.
SleepOptions: Options for the sleep function, containing the sleep duration in milliseconds.
StartMeetingProgressTimerOptions: Options for starting the meeting progress timer.
StartMeetingProgressTimerParameters: Parameters for starting the meeting progress timer.
StartRecordingOptions
StartRecordingParameters: Parameters required for starting the recording.
StartRecordsOptions: Options for starting a recording.
StartShareScreenOptions: Options for starting screen sharing.
StartShareScreenParameters: Parameters for starting screen sharing.
StoppedRecordingData
StoppedRecordingOptions: Options for showing the recording stopped alert message.
StopRecordingOptions
StopRecordingParameters: Parameters required to stop the recording.
StopShareScreenOptions: Options for the stopShareScreen function.
StopShareScreenParameters: Parameters required for stopping screen sharing. Extends multiple parameter interfaces from your TypeScript definitions.
Stream
StreamSuccessAudioOptions: StreamSuccessAudioOptions class equivalent to your TypeScript interface
StreamSuccessAudioParameters: StreamSuccessAudioParameters class equivalent to your TypeScript interface
StreamSuccessAudioSwitchOptions: Represents the options required to perform StreamSuccessAudioSwitch.
StreamSuccessAudioSwitchParameters: Represents the parameters required for StreamSuccessAudioSwitch.
StreamSuccessScreenOptions
StreamSuccessScreenParameters
StreamSuccessVideoOptions
StreamSuccessVideoParameters
SubAspectComponent: SubAspectComponent - A widget for displaying a sub-aspect component with customizable features.
SubAspectComponentOptions: SubAspectComponentOptions - Configuration options for the SubAspectComponent widget.
SwitchAudioOptions: Options for switching the audio input device.
SwitchAudioParameters
SwitchUserAudioOptions
SwitchUserAudioParameters
SwitchUserVideoAltOptions
SwitchUserVideoAltParameters
SwitchUserVideoOptions
SwitchUserVideoParameters
SwitchVideoAltOptions: Options for switching the user's video with alternate logic.
SwitchVideoAltParameters
SwitchVideoOptions: Options for switching the user's video device.
SwitchVideoParameters: Parameters for switching the user's video device.
TextSpecs
TimeLeftRecordingData
TimeLeftRecordingOptions: Options to manage the time left for recording.
TransportType
TriggerOptions: Options required to trigger a screen update.
TriggerParameters: Represents parameters required for the trigger function. Interface for Trigger parameters, similar to the React Native TypeScript interface.
UnsafeAlertData
UnSafeData
UpdateConsumingDomainsData
UpdateConsumingDomainsOptions: Represents the options for updating consuming domains.
UpdateConsumingDomainsParameters: Represents the parameters required for updating consuming domains.
UpdatedCoHostData
UpdatedCoHostOptions: Represents the options for updating co-host status and responsibilities.
UpdateMediaSettingsData
UpdateMediaSettingsOptions: Represents the options for updating media settings, including functions to update each setting.
UpdateMiniCardsGridOptions: Options for configuring the mini cards grid update.
UpdateMiniCardsGridParameters: Parameters required for updating the mini cards grid layout.
UpdateParticipantAudioDecibelsOptions: Represents the options for updating the audio decibels of a participant.
UpdateRecordingOptions: Options for the updateRecording function, containing recording parameters.
UpdateRecordingParameters: Parameters required for updating the recording state, implementing several interfaces for managing recording and timer state, and providing abstract getters for flexible and detailed recording configurations.
UpdateRoomParametersClientOptions: Options class for updating room parameters
UpdateRoomParametersClientParameters: Parameters for updating room configuration
UserRecordingParams
UserWaitingData
UserWaitingOptions: Represents the options for the user waiting event, including user details and alert/updating functions.
ValidateAlphanumericOptions: Options for the alphanumeric validation, containing the string to validate.
VidCons
VideoCard: VideoCard - A widget for displaying a video card with customizable features.
VideoCardOptions: Configuration options for the VideoCard widget.
VideoCardParameters: VideoCardParameters - Defines the parameters required for the VideoCard widget.
WaitingRoomModal: A modal interface to manage participants in a waiting room, allowing hosts to accept or reject entries.
WaitingRoomModalOptions: Options for the WaitingRoomModal.
WaitingRoomModalParameters: Additional parameters for the WaitingRoomModal.
WaitingRoomParticipant
WelcomePage: WelcomePage is a StatefulWidget that provides a welcome screen where users can enter details for an event, including event display name, token (secret), event ID, and event link. It includes options to validate input, handle socket connection, and provide feedback using alerts.
WelcomePageOptions
WhiteboardActionData
WhiteboardData
WhiteboardUpdatedData
WhiteboardUser

Enums

ControlsPosition
EventType
InfoPosition

Constants

requestDisplayNames → const Map<String, String>: Handles the response of a host to a participant's request.

Properties

maxAttempts ↔ int: This file contains the implementation of the WelcomePage widget. Implement the qr_code_scanner package to scan QR codes using the 'welcome_page.qrcode.dart' file.
getter/setter pair
rateLimitDuration ↔ int: getter/setter pair

Functions

addVideosGrid(AddVideosGridOptions options) → Future<void>: Adds video and audio streams of participants to the main and alternate grids based on specified options.
allMembers(AllMembersOptions options) → Future<void>: Manages all members and updates the UI.
allMembersRest(AllMembersRestOptions options) → Future<void>: Main function to handle participant updates, settings, and server connections in the room.
allWaitingRoomMembers(AllWaitingRoomMembersOptions options) → Future<void>: Updates the waiting room participants list and the total count of waiting room participants.
autoAdjust(AutoAdjustOptions options) → Future<List<int>>: Adjusts values based on the provided options and the number of participants.
banParticipant(BanParticipantOptions options) → Future<void>: Bans a participant by removing them from the active and display names lists, updating the participants list, and reordering the streams if necessary.
breakoutRoomUpdated(BreakoutRoomUpdatedOptions options) → Future<void>: Handles breakout room updates based on the received data and parameters.
calculateRowsAndColumns(CalculateRowsAndColumnsOptions options) → List<int>: Calculates the number of rows and columns needed to display a given number of items in a grid.
changeVids(ChangeVidsOptions options) → Future<void>: Changes the video streams on the screen based on the provided options and parameters.
checkGrid(CheckGridOptions options) → Future<List>: Checks the grid configuration and calculates various parameters based on the number of rows, columns, and active elements.
checkLimitsAndMakeRequest({required String apiUserName, required String apiToken, required String link, required String userName, required PreJoinPageParameters parameters, bool validate = true}) → Future<void>: checkLimitsAndMakeRequest
checkPauseState(CheckPauseStateOptions options) → Future<bool>: Checks if the recording can be paused based on the current pause count and the allowed limits.
checkPermission(CheckPermissionOptions options) → Future<int>: Checks the permission based on the provided settings.
checkResumeState({required CheckResumeStateOptions options}) → Future<bool>: Checks if the user can resume recording based on the provided options.
checkScreenShare(CheckScreenShareOptions options) → Future<void>: Checks and manages screen sharing status, initiating or stopping screen share actions based on conditions.
clickAudio(ClickAudioOptions options) → Future<void>: Toggles audio for a user, either enabling or disabling the microphone.
clickChat({required ClickChatOptions options}) → void: Toggles the visibility of the chat modal based on the current state and event settings.
clickScreenShare(ClickScreenShareOptions options) → Future<void>: Handles the action for the screen button, including starting and stopping screen sharing.
clickVideo(ClickVideoOptions options) → Future<void>: Toggles the video stream on or off based on the user's input and checks required permissions and constraints.
closeAndResize(CloseAndResizeOptions options) → Future<void>: Manages the closing and resizing of streams within a media session, adapting the layout and updating participant and stream information as needed.
compareActiveNames(CompareActiveNamesOptions options) → Future<void>: Compares the current activeNames list with the prevActiveNames list and triggers an action if there are any differences. The function updates prevActiveNames after the comparison to keep track of changes.
compareScreenStates(CompareScreenStatesOptions options) → Future<void>: Compares the current screenStates list with the prevScreenStates list and triggers actions if there are differences. This is useful for detecting changes in screen states and responding accordingly in a real-time application.
confirmExit(ConfirmExitOptions options) → Future<void>: Confirms the exit of a member from a room and optionally bans them.
confirmRecording(ConfirmRecordingOptions options) → Future<void>: Confirms the recording based on the provided parameters.
connectIps(ConnectIpsOptions options) → Future<List>: Connects to multiple remote IPs to manage socket connections for media consumption.
connectLocalIps(ConnectLocalIpsOptions options) → Future<void>: Connects to a local socket and manages socket events for media consumption.
connectLocalSendTransportAudio({required ConnectSendTransportAudioOptions options}) → Future<void>: Connects the local send transport for audio by producing audio data and updating the local audio producer and transport.
connectLocalSendTransportScreen({required MediaStream stream, required ConnectSendTransportScreenParameters parameters}) → Future<void>
connectLocalSendTransportVideo({required MediaStream stream, required MediaStreamTrack track, required List<RtpEncodingParameters> encodings, required ProducerCodecOptions codecOptions, RtpCodecCapability? codec, required ConnectSendTransportVideoParameters parameters}) → Future<void>
connectLocalSocket(ConnectLocalSocketOptions options) → Future<ResponseLocalConnection>: Connects to a media socket with the specified options. Returns a ResponseLocalConnection containing the socket and connection data. Throws an exception if inputs are invalid or if connection fails. Example usage:
connectRecvTransport(ConnectRecvTransportOptions options) → Future<void>: Establishes a connection for the receiving transport to consume media from a remote producer and resumes the consumer stream.
connectSendTransport(ConnectSendTransportOptions options) → Future<void>: Connects send transport for audio, video, or screen based on the specified option.
connectSendTransportAudio(ConnectSendTransportAudioOptions options) → Future<void>: Sets up and connects the audio stream for media sharing, handling updates to local audio streams and producer transports.
connectSendTransportScreen(ConnectSendTransportScreenOptions options) → Future<void>: Sets up and initiates the screen-sharing transport connection, configuring codec options and producing a video track for screen sharing.
connectSendTransportVideo(ConnectSendTransportVideoOptions options) → Future<void>: Establishes a video transport connection, configuring video encoding and codec options for video transmission.
connectSocket(ConnectSocketOptions options) → Future<Socket>: Connects to a media socket with the specified options. Validates the API key or token and initiates a socket connection.
consumerResume(ConsumerResumeOptions options) → Future<void>: Handles the resumption of a media stream (either audio or video) by managing the socket connections, updating the UI, and reordering streams as necessary.
controlMedia(ControlMediaOptions options) → Future<void>: Controls media for a participant in a room by sending a controlMedia event to the server.
controlMediaHost(ControlMediaHostOptions options) → Future<void>: Controls media actions based on the specified ControlMediaHostOptions.
createDeviceClient({required CreateDeviceClientOptions options}) → Future<Device?>: Creates a mediasoup client device with the provided RTP capabilities.
createLocalSendTransport(CreateSendTransportOptions options) → Future<void>
createRoomOnMediaSFU(CreateMediaSFUOptions options) → Future<CreateJoinRoomResult>: createRoomOnMediaSFU
createSendTransport(CreateSendTransportOptions options) → Future<void>: Creates a WebRTC send transport for media transmission (audio, video, or screen).
disconnect(DisconnectOptions options) → void: Disconnects the user from the session, updating the necessary state and triggering alerts if needed.
disconnectLocalSendTransportAudio(DisconnectSendTransportAudioOptions options) → Future<void>: Disconnects the local send transport for audio by pausing the local audio producer and notifying the server.
disconnectLocalSendTransportScreen(DisconnectSendTransportScreenOptions options) → Future<void>: Disconnects the local send transport for screen sharing by closing the local screen producer and notifying the server.
disconnectLocalSendTransportVideo(DisconnectSendTransportVideoOptions options) → Future<void>: Disconnects the local send transport for video by closing the local video producer and notifying the server.
disconnectSendTransportAudio(DisconnectSendTransportAudioOptions options) → Future<void>: Disconnects the send transport for audio by pausing the audio producer(s) and updating the UI accordingly.
disconnectSendTransportScreen(DisconnectSendTransportScreenOptions options) → Future<void>: Disconnects the send transport for screen sharing by closing the screen producer and notifying the server.
disconnectSendTransportVideo(DisconnectSendTransportVideoOptions options) → Future<void>: Disconnects the send transport for video by closing the video producer(s), updating the UI, and notifying the server.
disconnectSocket(DisconnectSocketOptions options) → Future<bool>: Disconnects the given socket instance. Returns true upon successful disconnection.
disconnectUserSelf(DisconnectUserSelfOptions options) → Future<void>: Disconnects the user from the specified room and bans them.
dispStreams(DispStreamsOptions options) → Future<void>: Displays streams in the media application based on a range of parameters and conditions.
formatElapsedTime(int recordElapsedTime) → String
formatNumber(FormatNumberOptions options) → Future<String?>: Formats a given number into a human-readable string representation with suffixes (K, M, B).
generatePageContent(GeneratePageContentOptions options) → Future<void>: Generates the content for a specific page based on the provided options.
generateRandomMessages(GenerateRandomMessagesOptions options) → List<Message>: Generates random messages for a chat application based on specified options.
generateRandomParticipants(GenerateRandomParticipantsOptions options) → List<Participant>: Generates a list of random participants for a meeting based on specified options.
generateRandomPolls(GenerateRandomPollsOptions options) → List<Poll>: Generates a list of random polls for testing.
generateRandomRequestList(GenerateRandomRequestListOptions options) → List<Request>: Generates a list of random requests for participants, excluding the host and co-host.
generateRandomWaitingRoomList() → List<WaitingRoomParticipant>: Generates a random list of participants for a waiting room.
getDomains(GetDomainsOptions options) → Future<void>: Connects to specified domains, processes IPs, and handles domain-related connections.
getEstimate(GetEstimateOptions options) → List<int>: Estimates the number of rows and columns based on the provided options.
getModalPosition(GetModalPositionOptions options) → Map<String, double>: Returns the position of a modal based on the specified options.
getOverlayPosition(GetOverlayPositionOptions options) → Map<String, dynamic>: Returns the overlay position based on the specified options.
getPipedProducersAlt(GetPipedProducersAltOptions options) → Future<void>: Retrieves piped producers and signals new consumer transport for each retrieved producer.
getProducersPiped({required GetProducersPipedOptions options}) → Future<void>: Retrieves piped producers and signals new consumer transport for each retrieved producer.
getVideos({required GetVideosOptions options}) → Future<void>: Processes and updates video streams by filtering out the admin's video stream.
handleCreatePoll(HandleCreatePollOptions options) → Future<void>: Handles the creation of a poll by emitting a "createPoll" event with the provided details. Shows an alert based on the success or failure of the operation.
handleEndPoll(HandleEndPollOptions options) → Future<void>: Handles ending a poll by emitting an "endPoll" event through the provided socket. Displays an alert based on the success or failure of the operation.
handleVotePoll(HandleVotePollOptions options) → Future<void>: Handles the voting process for a poll.
hostRequestResponse(HostRequestResponseOptions options) → Future<void>
joinConRoom(JoinConRoomOptions options) → Future<ResponseJoinRoom>: Joins a conference room with the provided options. Validates the input parameters before attempting to join the room.
joinConsumeRoom(JoinConsumeRoomOptions options) → Future<ResponseJoinRoom>: Joins a consumption room, initiates a media Device if necessary, and sets up piped transports for streaming.
joinRoom(JoinRoomOptions options) → Future<ResponseJoinRoom>: Joins a room on the socket server with specified options.
joinRoomClient(JoinRoomClientOptions options) → Future<ResponseJoinRoom>: Joins a room by emitting the joinRoom or joinConRoom event to the server using the provided socket.
joinRoomOnMediaSFU(JoinMediaSFUOptions options) → Future<CreateJoinRoomResult>: joinRoomOnMediaSFU
launchBreakoutRooms(LaunchBreakoutRoomsOptions options) → void: Launches the breakout rooms by toggling the visibility of the breakout rooms modal.
launchCoHost(LaunchCoHostOptions options) → void: Toggles the visibility of the co-host modal.
launchConfirmExit(LaunchConfirmExitOptions options) → void: Toggles the visibility of the confirmation exit modal.
launchDisplaySettings(LaunchDisplaySettingsOptions options) → void: Toggles the visibility of the display settings modal.
launchMediaSettings(LaunchMediaSettingsOptions options) → Future<void>: Launches the media settings modal and updates the available audio and video input devices.
launchMenuModal(LaunchMenuModalOptions options) → void: Toggles the visibility of the menu modal.
launchMessages(LaunchMessagesOptions options) → void: Toggles the visibility state of the messages modal.
launchParticipants(LaunchParticipantsOptions options) → void: Toggles the visibility of the participants modal.
launchPoll(LaunchPollOptions options) → void: Toggles the visibility of the poll modal based on the current state.
launchRecording(LaunchRecordingOptions options) → void: Launches the recording process based on various conditions and updates the UI accordingly.
launchRequests(LaunchRequestsOptions options) → void: Toggles the visibility state of the requests modal.
launchSettings(LaunchSettingsOptions options) → void: Toggles the visibility state of the settings modal.
launchWaiting(LaunchWaitingOptions options) → void: Launches the waiting modal and toggles its visibility state.
meetingEnded({required MeetingEndedOptions options}) → Future<void>: Handles the end of a meeting by showing an alert and performing a redirect if necessary.
meetingStillThere({required MeetingStillThereOptions options}) → Future<void>: Updates the visibility of the "still there?" modal in a meeting.
meetingTimeRemaining({required MeetingTimeRemainingOptions options}) → Future<void>: Updates the meeting time remaining and shows an alert if the event type is not 'chat'.
messageParticipants(MessageParticipantsOptions options) → void: Sends a direct message to a participant if the current member has the necessary permissions.
mixStreams({required MixStreamsOptions options}) → Future<List<Stream>>: Mixes video and audio streams and participants based on specified parameters.
modifyCoHostSettings(ModifyCoHostSettingsOptions options) → Future<void>: Modifies the co-host settings for a specified room.
modifyDisplaySettings(ModifyDisplaySettingsOptions options) → Future<void>: Adjusts meeting display settings, updating state variables and handling alerts.
modifySettings(ModifySettingsOptions options) → Future<void>: Modifies settings for a given room and updates the state accordingly.
muteParticipants(MuteParticipantsOptions options) → Future<void>: Mutes a participant in the room if the current member has the necessary permissions.
newPipeProducer(NewPipeProducerOptions options) → Future<void>: Initiates a new pipe producer by signaling a new consumer transport and updating display settings as needed.
onScreenChanges(OnScreenChangesOptions options) → Future<void>: Handles screen changes and adjusts the display settings based on event type and screen sharing status.
participantRequested(ParticipantRequestedOptions options) → void: Handles the participant request to join the event.
personJoined(PersonJoinedOptions options) → void: Function that handles a person joining an event.
pollUpdated(PollUpdatedOptions options) → Future<void>: Updates the poll state based on the provided options.
prepopulateUserMedia(PrepopulateUserMediaOptions options) → Future<List<Widget>?>: Populates the main media grid with video, audio, or mini-cards based on the media activity of the participant.
processConsumerTransports(ProcessConsumerTransportsOptions options) → Future<void>: Processes consumer transports to pause or resume video streams based on provided stream lists.
processConsumerTransportsAudio(ProcessConsumerTransportsAudioOptions options) → Future<void>: Adjusts the audio state of consumer transports based on provided streams.
producerClosed(ProducerClosedOptions options) → Future<void>: Handles the closure of a producer identified by its remote producer ID. This function updates the consumer transports and triggers close-and-resize operations.
producerMediaClosed(ProducerMediaClosedOptions options) → Future<void>: Handles the closure of a media producer's stream or screenshare.
producerMediaPaused(ProducerMediaPausedOptions options) → Future<void>: Pauses the media for a producer based on specified parameters.
producerMediaResumed(ProducerMediaResumedOptions options) → Future<void>: Resumes media for a specified participant in a meeting.
readjust({required ReadjustOptions options}) → Future<void>: Adjusts the layout parameters based on the current state, participant count, and event type.
receiveAllPipedTransports(ReceiveAllPipedTransportsOptions options) → Future<void>: Receives all piped transports for a specific room and member by requesting piped producers at different levels.
receiveMessage(ReceiveMessageOptions options) → Future<void>: Processes an incoming message and updates the message list and badge display based on specified rules. Filters out messages from banned participants and categorizes messages into group and direct. Displays a badge for new messages if certain conditions are met.
recordingNotice(RecordingNoticeOptions options) → Future<void>: Handles recording state changes and updates recording settings accordingly.
recordPauseTimer(RecordPauseTimerOptions options) → bool: Controls the recording timer by allowing pause and resume actions.
recordResumeTimer({required RecordResumeTimerOptions options}) → Future<bool>: Resumes the recording timer if it is not already running and can be paused/resumed.
recordStartTimer({required RecordStartTimerOptions options}) → Future<void>: Starts the recording timer by initializing the timer state and managing the timer interval.
recordUpdateTimer({required RecordUpdateTimerOptions options}) → void: Updates the recording timer and formats the elapsed time in HH:MM:SS format.
reInitiateRecording(ReInitiateRecordingOptions options) → Future<void>: Re-initiates the recording for a specified room and member.
removeParticipants(RemoveParticipantsOptions options) → Future<void>: Removes a participant from the room if the user has the necessary permissions.
reorderStreams(ReorderStreamsOptions options) → Future<void>: Reorders video streams in the participant grid based on user roles and screen share status.
rePort(RePortOptions options) → Future<void>: Re-ports the screen states and active names for the main screen in a conference or event session.
requestScreenShare(RequestScreenShareOptions options) → Future<void>: Requests permission to start screen sharing or initiates screen sharing if in local UI mode.
respondToRequests(RespondToRequestsOptions options) → Future<void>: Responds to incoming requests by updating the request list locally and notifying the server of the request status. This function is typically used to manage permissions or participation requests in real-time collaboration tools.
respondToWaiting({required RespondToWaitingOptions options}) → Future<void>: Responds to a waiting participant by allowing or denying access based on specified options.
resumeLocalSendTransportAudio(ResumeSendTransportAudioOptions options) → Future<void>: Resumes the local send transport for audio by resuming the local audio producer and updating the state.
resumePauseAudioStreams({required ResumePauseAudioStreamsOptions options}) → Future<void>: Resumes or pauses audio streams for participants based on breakout room status and event type.
resumePauseStreams({required ResumePauseStreamsOptions options}) → Future<void>: Resumes or pauses video streams based on active participants and display names.
resumeSendTransportAudio({required ResumeSendTransportAudioOptions options}) → Future<void>: Resumes the send transport for audio and updates the UI and audio producer state accordingly.
reUpdateInter(ReUpdateInterOptions options) → Future<void>: Updates the layout or content of the media streams based on user activity, screen share, or conference settings.
roomRecordParams(RoomRecordParamsOptions options) → void: Updates various recording parameters based on the provided recordParams.
screenProducerId(ScreenProducerIdOptions options) → void: Manages and updates screen sharing based on the producer ID.
sendMessage(SendMessageOptions options) → Future<void>: Sends a message to the specified room.
signalNewConsumerTransport(SignalNewConsumerTransportOptions options) → Future<void>: Signals the creation of a new consumer transport.
sleep(SleepOptions options) → Future<void>: Suspends the execution of the current isolate for the specified options.ms milliseconds.
startMeetingProgressTimer({required StartMeetingProgressTimerOptions options}) → void: Starts a timer to track the progress of a meeting.
startRecording(StartRecordingOptions options) → Future<bool?>: Starts the recording process, managing different states and actions based on recording options.
startRecords(StartRecordsOptions options) → Future<void>: Starts recording for a specified room.
startShareScreen(StartShareScreenOptions options) → Future<void>: Starts the screen sharing process.
stoppedRecording(StoppedRecordingOptions options) → Future<void>: Displays an alert message when the recording has stopped, indicating the reason.
stopRecording(StopRecordingOptions options) → Future<void>: Stops the recording process, managing different states and actions based on current recording status.
stopShareScreen(StopShareScreenOptions options) → Future<void>: Stops the screen sharing process and updates various states and UI elements accordingly.
streamSuccessAudio(StreamSuccessAudioOptions options) → Future<void>: Manages the setup and successful transition of audio streaming by configuring necessary transports, updating audio settings, and updating UI state as required.
streamSuccessAudioSwitch(StreamSuccessAudioSwitchOptions options) → Future<void>: Manages switching to a new audio stream, updating the audio producer, local streams, and UI state as necessary.
streamSuccessScreen(StreamSuccessScreenOptions options) → Future<void>: Handles the successful initiation and management of screen sharing, including setting up necessary transports, managing screen states, and updating the user interface accordingly.
streamSuccessVideo(StreamSuccessVideoOptions options) → Future<void>: Handles successful video streaming setup by initializing video transports, managing UI states, and updating participant information to reflect the video status.
switchAudio(SwitchAudioOptions options) → Future<void>: Switches the audio input device based on user preference.
switchUserAudio({required SwitchUserAudioOptions options}) → Future<void>: Switches the user's audio input to the specified device.
switchUserVideo(SwitchUserVideoOptions options) → Future<void>: Toggles or switches the video stream based on user preferences and permission checks.
switchUserVideoAlt(SwitchUserVideoAltOptions options) → Future<void>: Switches video input devices, handling permission checks, device switching, and error handling.
switchVideo(SwitchVideoOptions options) → Future<void>: Switches the user's video device based on the provided video preference.
switchVideoAlt(SwitchVideoAltOptions options) → Future<void>: Switches the user's video device with alternate logic, taking into account recording state and camera access permissions.
timeLeftRecording(TimeLeftRecordingOptions options) → void: Displays an alert message indicating the remaining time left for recording.
trigger(TriggerOptions options) → Future<void>: Triggers a screen update based on various conditions and adjusts layouts as needed.
updateConsumingDomains(UpdateConsumingDomainsOptions options) → void: Updates consuming domains based on the provided options.
updatedCoHost(UpdatedCoHostOptions options) → void: Updates co-host information and responsibilities based on provided options.
updateMediaSettings(UpdateMediaSettingsOptions options) → void: Updates media settings by calling the respective update functions for each setting type.
updateMicLevel(Producer? audioProducer, void updateAudioLevel(double level)) → void: Updates the microphone audio level periodically.
updateMiniCardsGrid(UpdateMiniCardsGridOptions options) → Future<void>: Updates the mini cards grid layout based on the specified configuration.
updateParticipantAudioDecibels(UpdateParticipantAudioDecibelsOptions options) → void: Updates the audio decibels for a participant.
updateRecording(UpdateRecordingOptions options) → Future<void>: Updates the recording based on the given parameters, managing recording start, pause, and resume states, as well as providing alerts for required conditions.
updateRoomParametersClient({required UpdateRoomParametersClientOptions options}) → void: Updates the room configuration parameters based on provided options.
userWaiting(UserWaitingOptions options) → void: Handles the event when a user joins the waiting room.
validateAlphanumeric(ValidateAlphanumericOptions options) → Future<bool>: Validates if the provided string in options contains only alphanumeric characters.
validateApiKeyToken(String value) → Future<bool>: Validates the provided API key or token. Returns true if the API key or token is valid, otherwise throws an exception.

Typedefs

AddVideosGridType = Future<void> Function(AddVideosGridOptions options)
AlertComponentType = Widget Function({required AlertComponentOptions options})
AllMembersRestType = Future<void> Function(AllMembersRestOptions options)
AllMembersType = Future<void> Function(AllMembersOptions options)
AllWaitingRoomMembersType = Future<void> Function(AllWaitingRoomMembersOptions options)
AudioCardType = Widget Function({required AudioCardOptions options})
AudioGridType = Widget Function({required AudioGridOptions options})
AutoAdjustType = Future<List<int>> Function(AutoAdjustOptions options): Type definition for the autoAdjust function.
BanParticipantType = Future<void> Function(BanParticipantOptions options)
BreakoutRoom = List<BreakoutParticipant>
BreakoutRoomsModalType = Widget Function({required BreakoutRoomsModalOptions options}): Typedef for the BreakoutRoomsModal function.
BreakoutRoomUpdatedType = Future<void> Function(BreakoutRoomUpdatedOptions options)
CalculateRowsAndColumnsType = List<int> Function(CalculateRowsAndColumnsOptions options): Type definition for the calculateRowsAndColumns function.
CaptureCanvasStreamType = void Function(CaptureCanvasStreamOptions options)
CardVideoDisplayType = Widget Function({required CardVideoDisplayOptions options})
ChangeVidsType = Future<void> Function(ChangeVidsOptions options)
CheckGridType = Future<List> Function(CheckGridOptions options): Type definition for the checkGrid function.
CheckLimitsAndMakeRequestType = Future<void> Function({required String apiToken, required String apiUserName, required String link, required PreJoinPageParameters parameters, required String userName, bool validate}): CheckLimitsAndMakeRequestType
CheckPauseStateType = Future<bool> Function(CheckPauseStateOptions options)
CheckPermissionType = Future<int> Function(CheckPermissionOptions options): Type definition for the checkPermission function.
CheckResumeStateType = Future<bool> Function(CheckResumeStateOptions options)
CheckScreenShareType = Future<void> Function(CheckScreenShareOptions options): Type definition for the checkScreenShare function.
ClickAudioType = Future<void> Function(ClickAudioOptions options)
ClickChatType = void Function({required ClickChatOptions options})
ClickScreenShareType = Future<void> Function(ClickScreenShareOptions options): Type definition for the clickScreenShare function.
ClickVideoType = Future<void> Function(ClickVideoOptions options)
CloseAndResizeType = Future<void> Function(CloseAndResizeOptions options)
CoHostModalType = Widget Function({required CoHostModalOptions options})
CompareActiveNamesType = Future<void> Function(CompareActiveNamesOptions options): Type definition for the compareActiveNames function.
CompareScreenStatesType = Future<void> Function(CompareScreenStatesOptions options): Type definition for the compareScreenStates function.
ConfirmExitModalType = ConfirmExitModal Function({required ConfirmExitModalOptions options})
ConfirmExitType = Future<void> Function(ConfirmExitOptions options): Type definition for the function that confirms a member's exit.
ConfirmHereModalType = Widget Function({required ConfirmHereModalOptions options})
ConfirmRecordingType = Future<void> Function(ConfirmRecordingOptions options): Type alias for confirm recording function.
ConnectIpsType = Future<List> Function(ConnectIpsOptions options): Type definition for the connectIps function.
ConnectLocalIpsType = Future<void> Function(ConnectLocalIpsOptions options): Type definition for the connectLocalIps function.
ConnectLocalSocketType = Future<ResponseLocalConnection> Function(ConnectLocalSocketOptions options)
ConnectRecvTransportType = Future<void> Function(ConnectRecvTransportOptions options): Type definition for the connectRecvTransport function.
ConnectSendTransportAudioType = Future<void> Function(ConnectSendTransportAudioOptions options)
ConnectSendTransportScreenType = Future<void> Function(ConnectSendTransportScreenOptions options)
ConnectSendTransportType = Future<void> Function(ConnectSendTransportOptions options)
ConnectSendTransportVideoType = Future<void> Function(ConnectSendTransportVideoOptions options)
ConnectSocketType = Future<Socket> Function(ConnectSocketOptions options)
ConsumerResumeType = Future<void> Function(ConsumerResumeOptions options)
ConsumeSocket = Map<String, Socket>
ControlButtonsAltComponentType = Widget Function({required ControlButtonsAltComponentOptions options})
ControlButtonsComponentTouchType = Widget Function(ControlButtonsComponentTouchOptions options)
ControlButtonsComponentType = Widget Function(ControlButtonsComponentOptions options)
ControlMediaHostType = Future<void> Function(ControlMediaHostOptions options)
ControlMediaType = Future<void> Function(ControlMediaOptions options)
CreateDeviceClientType = Future<Device?> Function({required CreateDeviceClientOptions options})
CreateJoinRoomType = Future<CreateJoinRoomResult> Function({required String apiKey, required String apiUserName, required Map<String, dynamic> payload})
CreateRoomOnMediaSFUType = Future<CreateJoinRoomResult> Function(CreateMediaSFUOptions options)
CreateSendTransportType = Future<void> Function(CreateSendTransportOptions options)
CustomButtonsType = Widget Function(CustomButtonsOptions options)
DisconnectSendTransportAudioType = Future<void> Function(DisconnectSendTransportAudioOptions options): Type definition for the disconnectSendTransportAudio function.
DisconnectSendTransportScreenType = Future<void> Function(DisconnectSendTransportScreenOptions options): Type definition for disconnectSendTransportScreen function
DisconnectSendTransportVideoType = Future<void> Function(DisconnectSendTransportVideoOptions options): Type definition for disconnectSendTransportVideo function.
DisconnectSocketType = Future<bool> Function(DisconnectSocketOptions options)
DisconnectType = void Function(DisconnectOptions options)
DisconnectUserSelfType = Future<void> Function(DisconnectUserSelfOptions options)
DisplaySettingsModalType = DisplaySettingsModal Function({required DisplaySettingsModalOptions options})
DispStreamsType = Future<void> Function(DispStreamsOptions options): Function type definition for displaying streams.
EventSettingsModalType = Widget Function({required EventSettingsModalOptions options})
FlexibleGridType = Widget Function({required FlexibleGridOptions options})
FlexibleVideoType = Widget Function({required FlexibleVideoOptions options})
FormatNumberType = Future<String?> Function(FormatNumberOptions options): Type definition for the formatNumber function.
GeneratePageContentType = Future<void> Function(GeneratePageContentOptions options)
GenerateRandomMessagesType = List<Message> Function(GenerateRandomMessagesOptions options)
GenerateRandomParticipantsType = List<Participant> Function(GenerateRandomParticipantsOptions options)
GenerateRandomPollsType = List<Poll> Function(GenerateRandomPollsOptions options)
GenerateRandomRequestListType = List<Request> Function(GenerateRandomRequestListOptions options)
GenerateRandomWaitingRoomListType = List<WaitingRoomParticipant> Function()
GetDomainsType = Future<void> Function(GetDomainsOptions options)
GetEstimateType = List<int> Function(GetEstimateOptions options)
GetModalPositionType = Map<String, double> Function(GetModalPositionOptions options)
GetOverlayPositionType = Map<String, dynamic> Function(GetOverlayPositionOptions options)
GetPipedProducersAltType = Future<void> Function(GetPipedProducersAltOptions options)
GetProducersPipedType = Future<void> Function(GetProducersPipedOptions options)
GetVideosType = Future<void> Function({required GetVideosOptions options})
HandleCreatePollType = Future<void> Function(HandleCreatePollOptions options)
HandleEndPollType = Future<void> Function(HandleEndPollOptions options)
HandleVotePollType = Future<void> Function(HandleVotePollOptions options)
HostRequestResponseType = Future<void> Function(HostRequestResponseOptions options)
JoinConRoomType = Future<ResponseJoinRoom> Function(JoinConRoomOptions options)
JoinConsumeRoomType = Future<Map<String, dynamic>> Function(JoinConsumeRoomOptions options)
JoinRoomClientType = Future<ResponseJoinRoom> Function(JoinRoomClientOptions options)
JoinRoomOnMediaSFUType = Future<CreateJoinRoomResult> Function(JoinMediaSFUOptions options)
JoinRoomType = Future<ResponseJoinRoom> Function(JoinRoomOptions options)
LaunchBackgroundType = void Function(LaunchBackgroundOptions options)
LaunchBreakoutRoomsType = void Function(LaunchBreakoutRoomsOptions options): Type definition for the function that launches breakout rooms.
LaunchCoHostType = void Function(LaunchCoHostOptions options): Type definition for the function that launches the co-host modal.
LaunchConfigureWhiteboardType = void Function(LaunchConfigureWhiteboardOptions options)
LaunchConfirmExitType = void Function(LaunchConfirmExitOptions options): Type definition for the function that toggles the confirmation exit modal.
LaunchDisplaySettingsType = void Function(LaunchDisplaySettingsOptions options): Type definition for the function that launches the display settings modal.
LaunchMediaSettingsType = Future<void> Function(LaunchMediaSettingsOptions options): Type definition for the function that launches the media settings modal.
LaunchMenuModalType = void Function(LaunchMenuModalOptions options): Type definition for the function that toggles the menu modal.
LaunchMessagesType = void Function(LaunchMessagesOptions options): Type definition for the function that toggles the messages modal.
LaunchParticipantsType = void Function(LaunchParticipantsOptions options): Type definition for the function that launches the participants modal.
LaunchPollType = void Function(LaunchPollOptions options): Type definition for the function that toggles the poll modal visibility.
LaunchRecordingType = void Function(LaunchRecordingOptions options): Type alias for the launch recording function.
LaunchRequestsType = void Function(LaunchRequestsOptions options)
LaunchSettingsType = void Function(LaunchSettingsOptions options): Type definition for the launchSettings function.
LaunchWaitingType = void Function(LaunchWaitingOptions options): Signature for a function that updates the visibility of the waiting modal.
LoadingModalType = Widget Function({required LoadingModalOptions options})
MainAspectComponentType = Widget Function({required MainAspectComponentOptions options})
MainContainerComponentType = Widget Function({required MainContainerComponentOptions options})
MainGridComponentType = Widget Function({required MainGridComponentOptions options})
MainScreenComponentType = Widget Function({required MainScreenComponentOptions options})
MediaSettingsModalType = MediaSettingsModal Function({required MediaSettingsModalOptions options})
MediaStream = MediaStream
MeetingEndedType = Future<void> Function(MeetingEndedOptions options)
MeetingProgressTimerType = Widget Function({required MeetingProgressTimerOptions options})
MeetingStillThereType = Future<void> Function(MeetingStillThereOptions options)
MeetingTimeRemainingType = Future<void> Function(MeetingTimeRemainingOptions options)
MenuModalType = Widget Function(MenuModalOptions options)
MessageParticipantsType = void Function(MessageParticipantsOptions options): Type definition for the function that sends a message to participants.
MessagesModalType = MessagesModal Function({required MessagesModalOptions options})
MiniAudioPlayerType = Widget Function(MiniAudioPlayerOptions options): Typedef for MiniAudioPlayerType.
MiniAudioType = Widget Function({required MiniAudioOptions options})
MiniCardType = Widget Function({required MiniCardOptions options})
MixStreamsType = Future<List<Stream>> Function({required MixStreamsOptions options})
ModifyCoHostSettingsType = Future<void> Function(ModifyCoHostSettingsOptions options): Type definition for modifying co-host settings.
ModifyDisplaySettingsType = Future<void> Function(ModifyDisplaySettingsOptions options)
ModifySettingsType = Future<void> Function(ModifySettingsOptions options): Type definition for the modifySettings function.
MuteParticipantsType = Future<void> Function(MuteParticipantsOptions options): Type definition for the function that mutes a participant.
NewPipeProducerType = Future<void> Function(NewPipeProducerOptions options)
OnScreenChangesType = Future<void> Function(OnScreenChangesOptions options)
OtherGridComponentType = Widget Function({required OtherGridComponentOptions options})
PaginationType = Widget Function({required PaginationOptions options})
ParticipantRequestedType = void Function(ParticipantRequestedOptions options)
ParticipantsModalType = Widget Function({required ParticipantsModalOptions options})
PersonJoinedType = void Function(PersonJoinedOptions options)
PollModalType = PollModal Function({required PollModalOptions options})
PollUpdatedType = Future<void> Function(PollUpdatedOptions options): Type definition for the function that updates poll information.
PreJoinPageType = Widget Function({PreJoinPageOptions? options})
PrepopulateUserMediaType = Future<List<Widget>?> Function(PrepopulateUserMediaOptions options)
ProcessConsumerTransportsAudioType = Future<void> Function(ProcessConsumerTransportsAudioOptions options)
ProcessConsumerTransportsType = Future<void> Function(ProcessConsumerTransportsOptions options)
ProducerClosedType = Future<void> Function(ProducerClosedOptions options): Type definition for the producerClosed function.
ProducerMediaClosedType = Future<void> Function(ProducerMediaClosedOptions options)
ProducerMediaPausedType = Future<void> Function(ProducerMediaPausedOptions options)
ProducerMediaResumedType = Future<void> Function(ProducerMediaResumedOptions options)
ReadjustType = Future<void> Function({required ReadjustOptions options})
ReceiveAllPipedTransportsType = Future<void> Function(ReceiveAllPipedTransportsOptions options)
ReceiveMessageType = Future<void> Function(ReceiveMessageOptions options)
RecordingModalType = Widget Function({required RecordingModalOptions options})
RecordingNoticeType = Future<void> Function(RecordingNoticeOptions options)
RecordPauseTimerType = bool Function(RecordPauseTimerOptions options): Type alias for the recordPauseTimer function.
RecordResumeTimerType = Future<bool> Function({required RecordResumeTimerOptions options})
RecordStartTimerType = Future<void> Function({required RecordStartTimerOptions options})
RecordUpdateTimerType = void Function({required RecordUpdateTimerOptions options})
ReInitiateRecordingType = Future<void> Function(ReInitiateRecordingOptions options)
RemoveParticipantsType = Future<void> Function(RemoveParticipantsOptions options): Type definition for the function that removes a participant.
ReorderStreamsType = Future<void> Function(ReorderStreamsOptions options)
RePortType = Future<void> Function(RePortOptions options)
RequestPermissionAudioType = Future<bool> Function()
RequestPermissionCameraType = Future<bool> Function()
RequestScreenShareType = Future<void> Function(RequestScreenShareOptions options)
RequestsModalType = Widget Function({RequestsModalOptions options})
RespondToRequestsType = Future<void> Function(RespondToRequestsOptions options): Type definition for the respondToRequests function.
RespondToWaitingType = Future<void> Function({required RespondToWaitingOptions options})
ResumePauseAudioStreamsType = Future<void> Function({required ResumePauseAudioStreamsOptions options})
ResumePauseStreamsType = Future<void> Function({required ResumePauseStreamsOptions options})
ResumeSendTransportAudioType = Future<void> Function({required ResumeSendTransportAudioOptions options})
ReUpdateInterType = Future<void> Function(ReUpdateInterOptions options)
RoomRecordParamsType = void Function(RoomRecordParamsOptions options)
ScreenProducerIdType = void Function(ScreenProducerIdOptions options): Type definition for the screen producer ID function.
SendMessageType = Future<void> Function(SendMessageOptions options): Type definition for the function that sends a message.
ShareEventModalType = Widget Function({required ShareEventModalOptions options})
ShowAlert = void Function({required int duration, required String message, required String type})
SignalNewConsumerTransportType = Future<void> Function(SignalNewConsumerTransportOptions options): Function type definition for signaling a new consumer transport.
SleepType = Future<void> Function(SleepOptions options)
StartMeetingProgressTimerType = void Function({required StartMeetingProgressTimerOptions options})
StartRecordingType = Future<bool?> Function(StartRecordingOptions options)
StartRecordsType = Future<void> Function(StartRecordsOptions options): Type definition for the start recording function.
StartShareScreenType = Future<void> Function(StartShareScreenOptions options): Function type for starting screen sharing.
StoppedRecordingType = Future<void> Function(StoppedRecordingOptions options): Function type for stoppedRecording to define consistency in function signature.
StopRecordingType = Future<void> Function(StopRecordingOptions options)
StopShareScreenType = Future<void> Function(StopShareScreenOptions options): Function type definition for stopping screen sharing.
StreamSuccessAudioSwitchType = Future<void> Function(StreamSuccessAudioSwitchOptions options): Type definition for the StreamSuccessAudioSwitch function.
StreamSuccessAudioType = Future<void> Function(StreamSuccessAudioOptions options)
StreamSuccessScreenType = Future<void> Function(StreamSuccessScreenOptions options)
StreamSuccessVideoType = Future<void> Function(StreamSuccessVideoOptions options)
SubAspectComponentType = Widget Function({required SubAspectComponentOptions options})
SwitchAudioType = Future<void> Function(SwitchAudioOptions options)
SwitchUserAudioType = Future<void> Function({required SwitchUserAudioOptions options})
SwitchUserVideoAltType = Future<void> Function(SwitchUserVideoAltOptions options)
SwitchUserVideoType = Future<void> Function(SwitchUserVideoOptions options)
SwitchVideoAltType = Future<void> Function(SwitchVideoAltOptions options)
SwitchVideoType = Future<void> Function(SwitchVideoOptions options): Type definition for the switchVideo function.
TimeLeftRecordingType = void Function(TimeLeftRecordingOptions options)
TriggerType = Future<void> Function(TriggerOptions options)
UpdateAddAltGrid = void Function(bool)
UpdateAddForBasic = void Function(bool value)
UpdateAdminPasscode = void Function(String)
UpdateAllVideoStreamsFunction = void Function(List<Stream>): Function type for updating the list of all video streams.
UpdateAParams = void Function(ProducerOptionsType)
UpdateAudioOnlyRoom = void Function(bool)
UpdateAudioProducer = void Function(Producer? producer)
UpdateAudioSetting = void Function(String)
UpdateAutoWave = void Function(bool)
UpdateBoolean = void Function(bool)
UpdateBooleanState = void Function(bool)
UpdateBreakOutRoomEnded = void Function(bool ended)
UpdateBreakoutRooms = void Function(List<List<BreakoutParticipant>> rooms)
UpdateBreakOutRoomStarted = void Function(bool started)
UpdateCanRecord = void Function(bool canRecord)
UpdateChatSetting = void Function(String)
UpdateClearedToRecord = void Function(bool cleared)
UpdateCoHost = void Function(String)
UpdateCoHostResponsibility = void Function(List<CoHostResponsibility>)
UpdateConsumingDomainsType = Future<void> Function(UpdateConsumingDomainsOptions options)
UpdatedCoHostType = Future<void> Function(UpdatedCoHostOptions options)
UpdateEventType = void Function(EventType)
UpdateForceFullDisplay = void Function(bool)
UpdateFrameRate = void Function(int)
UpdateHostFirstSwitch = void Function(bool)
UpdateHostNewRoom = void Function(int room)
UpdateHParams = void Function(ProducerOptionsType)
UpdateIPs = void Function(List<String>)
UpdateIsMessagesModalVisible = void Function(bool isVisible): Type definition for updating the chat modal's visibility.
UpdateIsParticipantsModalVisible = void Function(bool): Callback function type for updating the visibility of the participants modal.
UpdateIsPollModalVisible = void Function(bool isVisible)
UpdateIsRecordingModalVisible = void Function(bool visible)
UpdateIsRequestsModalVisible = void Function(bool isVisible)
UpdateIsSettingsModalVisible = void Function(bool isVisible)
UpdateItemPageLimit = void Function(int value)
UpdateMainHeightWidth = void Function(double value)
UpdateMediaSettingsType = void Function(UpdateMediaSettingsOptions options): Type definition for updating media settings.
UpdateMeetingDisplayType = void Function(String type)
UpdateMeetingProgressTime = void Function(String formattedTime): Type definition for updating the meeting progress time in HH:MM:SS format.
UpdateMeetingRoomParams = void Function(MeetingRoomParams?)
UpdateMiniCardsGridType = Future<void> Function(UpdateMiniCardsGridOptions options)
UpdateOldAllStreamsFunction = void Function(List<Stream>): Function type for updating the list of old video streams.
UpdateOtherGridStreams = void Function(List<List<Widget>>)
UpdateParticipantAudioDecibelsType = void Function(UpdateParticipantAudioDecibelsOptions options)
UpdateParticipants = void Function(List<Participant> participants)
UpdateParticipantsAll = void Function(List<Participant> participants)
UpdateProducerTransport = void Function(Transport? producerTransport)
UpdateRecordElapsedTime = void Function(int elapsedTime)
UpdateRecordingAllParticipantsFullRoomSupport = void Function(bool)
UpdateRecordingAllParticipantsSupport = void Function(bool)
UpdateRecordingAudioOptions = void Function(String)
UpdateRecordingAudioParticipantsTimeLimit = void Function(int)
UpdateRecordingAudioPausesCount = void Function(int)
UpdateRecordingAudioPausesLimit = void Function(int)
UpdateRecordingAudioPeopleLimit = void Function(int)
UpdateRecordingAudioSupport = void Function(bool)
UpdateRecordingMultiFormatsSupport = void Function(bool)
UpdateRecordingPreferredOrientation = void Function(String)
UpdateRecordingProgressTime = void Function(String formattedTime)
UpdateRecordingSupportForOtherOrientation = void Function(bool)
UpdateRecordingType = Future<void> Function(UpdateRecordingParameters options): Typedef for the update recording function
UpdateRecordingVideoOptions = void Function(String)
UpdateRecordingVideoParticipantsFullRoomSupport = void Function(bool)
UpdateRecordingVideoParticipantsSupport = void Function(bool)
UpdateRecordingVideoParticipantsTimeLimit = void Function(int)
UpdateRecordingVideoPausesCount = void Function(int)
UpdateRecordingVideoPausesLimit = void Function(int)
UpdateRecordingVideoPeopleLimit = void Function(int)
UpdateRecordingVideoSupport = void Function(bool)
UpdateRequestList = void Function(List<Request>)
UpdateRoomParametersClientType = void Function(UpdateRoomParametersClientOptions options)
UpdateRoomRecvIPs = void Function(List<String>)
UpdateRtpCapabilities = void Function(RtpCapabilities?): Type definitions for update functions
UpdateScreenPageLimit = void Function(int)
UpdateScreenParams = void Function(ProducerOptionsType)
UpdateScreenProducer = void Function(Producer? producer)
UpdateScreenshareSetting = void Function(String)
UpdateSetting = void Function(String value)
UpdateSockets = void Function(List<ConsumeSocket>)
UpdateTargetResolution = void Function(String)
UpdateTargetResolutionHost = void Function(String)
UpdateTotalReqWait = void Function(int)
UpdateTransportCreated = void Function(bool transportCreated)
UpdateVidCons = void Function(VidCons)
UpdateVideoProducer = void Function(Producer? producer)
UpdateVideoSetting = void Function(String)
UpdateVParams = void Function(ProducerOptionsType)
UpdateYouAreCoHost = void Function(bool)
UserWaitingType = void Function(UserWaitingOptions options)
ValidateAlphanumericType = Future<bool> Function(ValidateAlphanumericOptions options)
VideoCardType = Widget Function({required VideoCardOptions options})
WaitingRoomModalType = WaitingRoomModal Function({Key? key, required WaitingRoomModalOptions options})
WelcomePageType = WelcomePage Function({WelcomePageOptions options})

types\types library

Classes

Enums

Constants

Properties

Functions

Typedefs

mediasfu_sdk package

types library