types\types_alt
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.
-
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
-
-
AudioCardOptions
-
AudioCardOptions - Configuration options for the
AudioCard
widget.
-
AudioCardParameters
-
AudioCardParameters - Abstract class defining parameters required for the
AudioCard
widget.
-
AudioData
-
-
AudioDecibels
-
-
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
-
-
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
-
-
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.
-
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
-
-
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
-
-
ConfirmExitModalOptions
-
ConfirmExitModalOptions - Defines configuration options for the
ConfirmExitModal
.
-
ConfirmExitOptions
-
Defines the options for confirming the exit of a member from a room.
-
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.
-
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.
-
ControlButtonsAltComponentOptions
-
ControlButtonsAltComponentOptions - Configures settings for the
ControlButtonsAltComponent
.
-
ControlButtonsComponentOptions
-
ControlButtonsComponentOptions
- Configuration options for the ControlButtonsComponent
.
-
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.
-
CreateRoomOptions
-
-
CreateSendTransportOptions
-
-
CreateSendTransportParameters
-
-
CreateWebRTCTransportResponse
-
-
CustomButton
-
CustomButton
- Defines options for each button within the CustomButtons
widget.
-
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.
-
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.
-
EventSettingsModalOptions
-
EventSettingsModalOptions - Defines configuration options for the
EventSettingsModal
.
-
FlexibleGridOptions
-
FlexibleGridOptions
- Configuration options for the FlexibleGrid
widget.
-
FlexibleVideoOptions
-
FlexibleVideoOptions
- Configuration options for the FlexibleVideo
widget.
-
FormatNumberOptions
-
Options for the formatNumber function.
-
GeneratePageContentOptions
-
Options for generating page content.
-
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.
-
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.
-
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
-
LoadingModalOptions
-
LoadingModalOptions
- Configuration options for the LoadingModal
widget.
-
MainAspectComponentOptions
-
MainAspectComponentOptions
- Configuration options for the MainAspectComponent
.
-
MainContainerComponentOptions
-
MainContainerComponentOptions
- Configuration options for MainContainerComponent
.
-
MainGridComponentOptions
-
MainGridComponentOptions
- Configuration options for the MainGridComponent
.
-
MainScreenComponentOptions
-
MainScreenComponentOptions
- Configuration options for the MainScreenComponent
widget.
-
MainSpecs
-
-
MediaSettingsModalOptions
-
MediaSettingsModalOptions - Defines configuration options for the
MediaSettingsModal
.
-
MediaSettingsModalParameters
-
MediaSettingsModalParameters
- Abstract class defining required parameters
for configuring media settings.
-
MeetingEndedOptions
-
Defines options for handling the end of a meeting.
-
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.
-
Options class for configuring the MenuModal widget.
-
Message
-
-
MessageParticipantsOptions
-
Defines options for messaging a participant.
-
MessagesModalOptions
-
-
MiniAudioOptions
-
MiniAudioOptions
- Configuration options for the MiniAudio
widget.
-
MiniAudioPlayerOptions
-
Options for
MiniAudioPlayer
.
-
MiniAudioPlayerParameters
-
Parameters for
MiniAudioPlayer
.
-
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.
-
OtherGridComponentOptions
-
OtherGridComponentOptions - Configuration options for the
OtherGridComponent
.
-
OverlayPositionStyle
-
-
PaginationOptions
- Configuration options for the Pagination
widget.
-
-
Participant
-
-
ParticipantRequestedData
-
-
ParticipantRequestedOptions
-
-
ParticipantsModalOptions
-
-
ParticipantsModalParameters
-
-
PersonJoinedOptions
-
Options for handling the event when a person joins.
-
Poll
-
-
PollModalOptions
-
-
PollUpdatedData
-
-
PollUpdatedOptions
-
Defines options for updating poll information.
-
PreJoinPageOptions
-
-
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.
-
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.
-
RecordStartTimerOptions
-
Options for initiating 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
-
-
RequestsModalOptions
-
Options for the RequestsModal widget.
-
RequestsModalParameters
-
-
RespondToRequestsOptions
-
Defines the options for responding to requests.
-
RespondToWaitingOptions
-
Options for responding to a waiting participant.
-
ResponseJoinRoom
-
-
ResumePauseAudioStreamsOptions
-
-
ResumePauseAudioStreamsParameters
-
-
ResumePauseStreamsOptions
-
-
ResumePauseStreamsParameters
-
-
ResumeSendTransportAudioOptions
-
-
ResumeSendTransportAudioParameters
-
-
ReUpdateInterOptions
-
-
ReUpdateInterParameters
-
-
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
-
-
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
-
-
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
-
-
VideoCardOptions
-
Configuration options for the
VideoCard
widget.
-
VideoCardParameters
-
VideoCardParameters - Defines the parameters required for the
VideoCard
widget.
-
WaitingRoomModalOptions
-
Options for the WaitingRoomModal.
-
WaitingRoomModalParameters
-
Additional parameters for the WaitingRoomModal.
-
WaitingRoomParticipant
-
-
WelcomePageOptions
-
-
WhiteboardActionData
-
-
WhiteboardData
-
-
WhiteboardUpdatedData
-
-
WhiteboardUser
-