ModernMediasfuGenericOptions class

Constructors

ModernMediasfuGenericOptions.new({PreJoinPageType? preJoinPageWidget, String? localLink = '', bool? connectMediaSFU = true, Credentials? credentials, bool? useLocalUIMode, SeedData? seedData, bool? useSeed, String? imgSrc, MediasfuParameters? sourceParameters, dynamic updateSourceParameters(MediasfuParameters?)?, bool? returnUI = true, CreateMediaSFURoomOptions? noUIPreJoinOptionsCreate, JoinMediaSFURoomOptions? noUIPreJoinOptionsJoin, JoinRoomOnMediaSFUType? joinMediaSFURoom = joinRoomOnMediaSFU, CreateRoomOnMediaSFUType? createMediaSFURoom = createRoomOnMediaSFU, VideoCardType? customVideoCard, AudioCardType? customAudioCard, MiniCardType? customMiniCard, CustomComponentType? customComponent, ContainerStyleOptions? containerStyle, MediasfuUICustomOverrides? uiOverrides, bool? useFixedLink, String? localAppKey, String? localApiUserName, String? localApiKey, String? localSubUserName, String? initialMeetingId, bool canUsePersonalTranslation = false, String? personalTranslationUsername, List<Map<String, dynamic>>? userVoiceClones, bool optimizeVideoRecord = false, VoidCallback? onBack, CustomWorkspaceBuilder? customWorkspaceBuilder})

Properties

canUsePersonalTranslation ↔ bool
Whether the user can use personal translation (billed to their account) When true and the room doesn't support translation, a personal translation request is automatically sent to the server
getter/setter pair
connectMediaSFU ↔ bool?
getter/setter pair
containerStyle ↔ ContainerStyleOptions?
getter/setter pair
createMediaSFURoom ↔ CreateRoomOnMediaSFUType?
getter/setter pair
credentials ↔ Credentials?
getter/setter pair
customAudioCard ↔ AudioCardType?
getter/setter pair
customComponent ↔ CustomComponentType?
getter/setter pair
customMiniCard ↔ MiniCardType?
getter/setter pair
customVideoCard ↔ VideoCardType?
getter/setter pair
customWorkspaceBuilder → CustomComponentType?
no setter
hashCode → int
The hash code for this object.
no setterinherited
imgSrc ↔ String?
getter/setter pair
initialMeetingId ↔ String?
Initial meeting ID to pre-fill in the prejoin page Used for deep links like /meeting/:roomId
getter/setter pair
joinMediaSFURoom ↔ JoinRoomOnMediaSFUType?
getter/setter pair
localApiKey ↔ String?
API key for backend authentication in socket handshake Used when connecting to local backend via localLink
getter/setter pair
localApiUserName ↔ String?
API username for backend authentication in socket handshake Used when connecting to local backend via localLink
getter/setter pair
localAppKey ↔ String?
App key for Flutter app authentication in socket handshake (X-App-Key) Used when connecting to local backend via localLink
getter/setter pair
getter/setter pair
localSubUserName ↔ String?
Sub-username for organization/team member identification Used for subuser accounts within an organization
getter/setter pair
noUIPreJoinOptionsCreate ↔ CreateMediaSFURoomOptions?
getter/setter pair
noUIPreJoinOptionsJoin ↔ JoinMediaSFURoomOptions?
getter/setter pair
onBack ↔ VoidCallback?
Optional callback for navigating back from the prejoin/setup page. When provided, the setup page back button will call this instead of using Navigator.maybePop. Useful for apps using GoRouter or custom routing.
getter/setter pair
optimizeVideoRecord ↔ bool
When true, keeps the urn:3gpp:video-orientation RTP header extension so recorded video has correct orientation metadata.
getter/setter pair
personalTranslationUsername ↔ String?
Username for personal translation billing Required when canUsePersonalTranslation is true
getter/setter pair
preJoinPageWidget ↔ PreJoinPageType?
getter/setter pair
returnUI ↔ bool?
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seedData ↔ SeedData?
getter/setter pair
sourceParameters ↔ MediasfuParameters?
getter/setter pair
uiOverrides ↔ MediasfuUICustomOverrides?
getter/setter pair
updateSourceParameters ↔ dynamic Function(MediasfuParameters?)?
getter/setter pair
Whether to use fixed link (stagerooms.mediasfu.com) instead of dynamic URL selection When true, always connects to stagerooms.mediasfu.com When false, URL is selected based on meeting ID prefix (d=demos, s=sandbox, p=production)
getter/setter pair
useLocalUIMode ↔ bool?
getter/setter pair
userVoiceClones ↔ List<Map<String, dynamic>>?
User's voice clones from their account, passed to the translation modal. Each clone is a map with keys: id, voiceId, name, provider, isDefault.
getter/setter pair
useSeed ↔ bool?
getter/setter pair

Methods

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

Operators

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