shared/com.mediasfu.sdk.methods/MediasfuParameters

MediasfuParameters

class MediasfuParameters : ConnectIpsParameters, ConnectLocalIpsParameters, BanParticipantParameters, ProducerMediaPausedParameters, ProducerMediaResumedParameters, ProducerMediaClosedParameters, ControlMediaHostParameters, UpdateConsumingDomainsParameters, BreakoutRoomUpdatedParameters, RoomRecordParamsParameters, RecordingNoticeParameters

Central parameter management class for MediaSFU SDK.

This class provides a simplified implementation of the core parameter management functionality needed by the MediaSFU SDK. It manages the global state and provides update functions for all state changes.

Key Features:

Manages WebRTC state (transports, producers, consumers)
Handles socket connections and events
Manages UI state and participant data
Provides update functions for all state changes

Usage:

val parameters = MediasfuParameters()

// Use in consumer methods
val options = ConnectIpsOptions(
    consumeSockets = emptyList(),
    remIP = listOf("100.122.1.1"),
    apiUserName = "user",
    apiToken = "token",
    parameters = parameters
)

val result = connectIps(options)

State Management:

All state is mutable and can be updated via update functions
State changes trigger callbacks for UI updates
Thread-safe access through coroutines

Constructors

MediasfuParameters

constructor()

Properties

activeNames

open override var activeNames: List<String>

activeSounds

open override var activeSounds: List<String>

addAltGrid

var addAltGrid: Boolean

addForBasic

open override var addForBasic: Boolean

addGrid

var addGrid: Boolean

adminIDStream

open override var adminIDStream: String

adminNameStream

open override var adminNameStream: String

adminOnMainScreen

open override var adminOnMainScreen: Boolean

adminPasscode

var adminPasscode: String

adminRestrictSetting

var adminRestrictSetting: Boolean

adminVidID

open override var adminVidID: String

alertDuration

var alertDuration: Int

alertMessage

var alertMessage: String

alertType

var alertType: String

alertVisible

var alertVisible: Boolean

allAudioStreams

open override var allAudioStreams: List<Stream>

allowed

var allowed: Boolean

allVideoStreams

open override val allVideoStreams: List<Stream>

allVideoStreamsState

var allVideoStreamsState: List<Stream>

altGridCols

var altGridCols: Int

altGridRows

var altGridRows: Int

annotateScreenStream

open override var annotateScreenStream: Boolean

aParams

var aParams: ProducerOptionsType?

apiKey

var apiKey: String

apiToken

var apiToken: String

apiUserName

var apiUserName: String

audioAlreadyOn

open override var audioAlreadyOn: Boolean

audioDecibels

open override var audioDecibels: List<AudioDecibels>

audioInputs

var audioInputs: List<MediaDeviceInfo>

audioLevel

var audioLevel: Double

audioOnlyRoom

var audioOnlyRoom: Boolean

audioOnlyStreams

var audioOnlyStreams: List<Any>

audioOutputs

var audioOutputs: List<MediaDeviceInfo>

audioParams

var audioParams: ProducerOptionsType?

audioPaused

var audioPaused: Boolean

audioProducer

open override var audioProducer: WebRtcProducer?

audioRequestState

var audioRequestState: String

audioRequestTime

var audioRequestTime: Long?

audioSetting

var audioSetting: String

audioSwitching

var audioSwitching: Boolean

audStreamNames

var audStreamNames: List<Stream>

autoWave

var autoWave: Boolean

backgroundHasChanged

var backgroundHasChanged: Boolean

breakOutRoomEnded

open override var breakOutRoomEnded: Boolean

breakoutRooms

open override var breakoutRooms: List<List<BreakoutParticipant>>

breakOutRoomStarted

open override var breakOutRoomStarted: Boolean

canLaunchRecord

open override var canLaunchRecord: Boolean

canPauseResume

open override var canPauseResume: Boolean

canRecord

var canRecord: Boolean

canStartBreakout

var canStartBreakout: Boolean

canStartWhiteboard

var canStartWhiteboard: Boolean

canvasStream

var canvasStream: MediaStream?

canvasWhiteboard

var canvasWhiteboard: Any?

changeVids

open override val changeVids: suspend (Any) -> Unit

chatAction

var chatAction: Boolean

chatAlreadyOn

var chatAlreadyOn: Boolean

chatRefStreams

var chatRefStreams: List<Stream>

chatRequestState

var chatRequestState: String

chatRequestTime

var chatRequestTime: Long?

chatSetting

var chatSetting: String

checkMediaPermission

var checkMediaPermission: Boolean

clearedToRecord

var clearedToRecord: Boolean

clearedToResume

var clearedToResume: Boolean

closeAndResize

open override val closeAndResize: CloseAndResizeType

coHost

var coHost: String

coHostResponsibility

var coHostResponsibility: List<CoHostResponsibility>

compareActiveNames

open override val compareActiveNames: suspend (CompareActiveNamesOptions) -> Unit

compareScreenStates

open override val compareScreenStates: suspend (CompareScreenStatesOptions) -> Unit

componentSizes

var componentSizes: ComponentSizes

confirmedToRecord

var confirmedToRecord: Boolean

connectIps

open override val connectIps: ConnectIpsType

consumerTransportInfos

var consumerTransportInfos: List<ConsumerTransportInfo>

consumerTransports

open override var consumerTransports: List<TransportType>

consumerTransportsWebRtc

var consumerTransportsWebRtc: List<WebRtcTransport>

consumeSockets

open override var consumeSockets: List<Map<String, SocketManager>>

consumeSocketsState

var consumeSocketsState: List<ConsumeSocket>

consumingTransports

var consumingTransports: List<String>

controlHeight

var controlHeight: Double

currentFacingMode

var currentFacingMode: String

currentRoomIndex

var currentRoomIndex: Int

currentStreams

var currentStreams: List<Stream>

currentTimeProvider

open override var currentTimeProvider: () -> Long

currentUserPage

var currentUserPage: Int

currentWhiteboardIndex

var currentWhiteboardIndex: Int?

customAudioCardBuilder

var customAudioCardBuilder: CustomAudioCardBuilder?

customMiniCardBuilder

var customMiniCardBuilder: CustomMiniCardBuilder?

customVideoCardBuilder

var customVideoCardBuilder: CustomVideoCardBuilder?

defAudioID

var defAudioID: String

deferReceive

open override var deferReceive: Boolean

deferScreenReceived

var deferScreenReceived: Boolean

defVideoID

var defVideoID: String

device

var device: WebRtcDevice?

directMessageDetails

var directMessageDetails: Participant?

disconnectSendTransportAudio

open override val disconnectSendTransportAudio: DisconnectSendTransportAudioType

disconnectSendTransportScreen

open override val disconnectSendTransportScreen: DisconnectSendTransportScreenType

disconnectSendTransportVideo

open override val disconnectSendTransportVideo: DisconnectSendTransportVideoType

dispActiveNames

open override var dispActiveNames: List<String>

doPaginate

var doPaginate: Boolean

endReport

var endReport: Boolean

eventType

open override var eventType: EventType

extendedRtpCapabilities

var extendedRtpCapabilities: OrtcUtils.ExtendedRtpCapabilities?

fastReorderInterval

open override var fastReorderInterval: Int

filteredParticipants

var filteredParticipants: List<Participant>

filteredRequestList

var filteredRequestList: List<Request>

filteredWaitingRoomList

var filteredWaitingRoomList: List<WaitingRoomParticipant>

firstAll

open override var firstAll: Boolean

firstRound

open override var firstRound: Boolean

fixedPageLimit

var fixedPageLimit: Int

forceFullDisplay

open override var forceFullDisplay: Boolean

frameRate

var frameRate: Int

getDomains

open override val getDomains: GetDomainsType

getVideos

open override val getVideos: suspend (GetVideosOptions) -> Unit

gotAllVids

open override var gotAllVids: Boolean

gridCols

var gridCols: Int

gridRows

var gridRows: Int

gridSizes

var gridSizes: GridSizes

hasAudioPermission

var hasAudioPermission: Boolean

hasCameraPermission

var hasCameraPermission: Boolean

hostFirstSwitch

var hostFirstSwitch: Boolean

hostLabel

open override var hostLabel: String

hostNewRoom

open override var hostNewRoom: Int

hParams

var hParams: ProducerOptionsType?

isBackgroundModalVisible

var isBackgroundModalVisible: Boolean

isBreakoutRoomsModalVisible

var isBreakoutRoomsModalVisible: Boolean

isCoHostModalVisible

var isCoHostModalVisible: Boolean

isConfigureWhiteboardModalVisible

var isConfigureWhiteboardModalVisible: Boolean

isConfirmExitModalVisible

var isConfirmExitModalVisible: Boolean

isConfirmHereModalVisible

var isConfirmHereModalVisible: Boolean

isDisplaySettingsModalVisible

var isDisplaySettingsModalVisible: Boolean

isLevel

open override val isLevel: String

islevel

open override var islevel: String

isLoadingModalVisible

var isLoadingModalVisible: Boolean

isMediaSettingsModalVisible

var isMediaSettingsModalVisible: Boolean

isMediumScreen

var isMediumScreen: Boolean

isMenuModalVisible

var isMenuModalVisible: Boolean

isMessagesModalVisible

var isMessagesModalVisible: Boolean

isParticipantsModalVisible

var isParticipantsModalVisible: Boolean

isPollModalVisible

var isPollModalVisible: Boolean

isRecordingModalVisible

var isRecordingModalVisible: Boolean

isRequestsModalVisible

var isRequestsModalVisible: Boolean

isScreenboardModalVisible

var isScreenboardModalVisible: Boolean

isSettingsModalVisible

var isSettingsModalVisible: Boolean

isShareEventModalVisible

var isShareEventModalVisible: Boolean

isSmallScreen

var isSmallScreen: Boolean

isTimerRunning

open override var isTimerRunning: Boolean

isWaitingModalVisible

var isWaitingModalVisible: Boolean

isWhiteboardModalVisible

var isWhiteboardModalVisible: Boolean

isWideScreen

open override var isWideScreen: Boolean

itemPageLimit

open override var itemPageLimit: Int

keepBackground

open override var keepBackground: Boolean

landScaped

var landScaped: Boolean

lastReorderTime

open override var lastReorderTime: Int

lastUpdate

open override var lastUpdate: Int?

level

open override var level: String

limitedBreakRoom

var limitedBreakRoom: List<BreakoutParticipant>

link

var link: String

localAudioProducer

open override var localAudioProducer: WebRtcProducer?

localProducerTransport

var localProducerTransport: WebRtcTransport?

localScreenProducer

open override var localScreenProducer: WebRtcProducer?

localSocket

open override var localSocket: SocketManager?

localStream

open override var localStream: MediaStream?

localStreamAudio

var localStreamAudio: MediaStream?

localStreamScreen

open override var localStreamScreen: MediaStream?

localStreamVideo

open override var localStreamVideo: MediaStream?

localTransportCreated

var localTransportCreated: Boolean

localUIMode

open override var localUIMode: Boolean

localVideoProducer

open override var localVideoProducer: WebRtcProducer?

lockScreen

open override var lockScreen: Boolean

lStreams

var lStreams: List<Stream>

lStreams_

var lStreams_: List<Stream>

mainGridStream

var mainGridStream: List<Any>

mainHeightWidth

open override var mainHeightWidth: Double

mainRoomsLength

var mainRoomsLength: Int

mainScreenFilled

open override var mainScreenFilled: Boolean

mainScreenPerson

open override var mainScreenPerson: String

meetingDisplayType

open override var meetingDisplayType: String

meetingElapsedTime

var meetingElapsedTime: Int

meetingProgressTime

var meetingProgressTime: String

meetingRoomParams

var meetingRoomParams: MeetingRoomParams?

meetingVideoOptimized

open override var meetingVideoOptimized: Boolean

member

open override var member: String

memberRoom

var memberRoom: Int

membersReceived

var membersReceived: Boolean

messages

var messages: List<Message>

micAction

var micAction: Boolean

mixedAlVideoStreams

var mixedAlVideoStreams: List<Stream>

negotiatedRecvRtpCapabilities

var negotiatedRecvRtpCapabilities: RtpCapabilities?

newLimitedStreams

open override var newLimitedStreams: List<Stream>

newLimitedStreamsIDs

open override var newLimitedStreamsIDs: List<String>

newParticipantAction

var newParticipantAction: String

nForReadjust

open override var nForReadjust: Int

nForReadjustRecord

var nForReadjustRecord: Int

nonAlVideoStreams

var nonAlVideoStreams: List<Stream>

nonAlVideoStreamsMuted

var nonAlVideoStreamsMuted: List<Stream>

nStream

var nStream: MediaStream?

numberPages

var numberPages: Int

oldAllStreams

open override var oldAllStreams: List<Stream>

oldSoundIds

open override var oldSoundIds: List<String>

onAlertStateChanged

var onAlertStateChanged: (String, String, Int) -> Unit?

onAudioAlreadyOnChanged

var onAudioAlreadyOnChanged: (Boolean) -> Unit?

onAudioOnlyStreamsUpdated

var onAudioOnlyStreamsUpdated: (List<Any>) -> Unit?

onLStreamsUpdated

var onLStreamsUpdated: (List<Stream>) -> Unit?

onMainGridStreamUpdated

var onMainGridStreamUpdated: (List<MediaSfuUIComponent>) -> Unit?

onOtherGridStreamsUpdated

var onOtherGridStreamsUpdated: (List<List<MediaSfuUIComponent>>) -> Unit?

onPaginatedStreamsUpdated

var onPaginatedStreamsUpdated: (List<List<Stream>>) -> Unit?

onParticipantsUpdated

var onParticipantsUpdated: (List<Participant>) -> Unit?

onRecordingStateChanged

var onRecordingStateChanged: () -> Unit?

onScreenAlreadyOnChanged

var onScreenAlreadyOnChanged: (Boolean) -> Unit?

onScreenChanges

open override val onScreenChanges: suspend (OnScreenChangesOptions) -> Unit

onSharedChanged

var onSharedChanged: (Boolean) -> Unit?

onShareScreenStartedChanged

var onShareScreenStartedChanged: (Boolean) -> Unit?

onVideoAlreadyOnChanged

var onVideoAlreadyOnChanged: (Boolean) -> Unit?

otherGridStreams

var otherGridStreams: List<List<MediaSfuUIComponent>>

pActiveNames

var pActiveNames: List<String>

paginatedStreams

var paginatedStreams: List<List<Stream>>

paginationDirection

var paginationDirection: String

paginationHeightWidth

var paginationHeightWidth: Double

params

var params: ProducerOptionsType?

participants

open override var participants: List<Participant>

participantsAll

open override var participantsAll: List<Participant>

participantsCounter

var participantsCounter: Int

participantsFilter

var participantsFilter: String

pauseLimit

var pauseLimit: Int

pauseRecordCount

var pauseRecordCount: Int

pDispActiveNames

var pDispActiveNames: List<String>

playSound

open override var playSound: SoundPlayer

poll

var poll: Poll?

polls

var polls: List<Poll>

prepopulateUserMedia

open override val prepopulateUserMedia: suspend (PrepopulateUserMediaOptions) -> Unit

prevActiveNames

open override var prevActiveNames: List<String>

prevAudioInputDevice

var prevAudioInputDevice: String

prevAudioOutputDevice

var prevAudioOutputDevice: String

prevDoPaginate

var prevDoPaginate: Boolean

prevFacingMode

var prevFacingMode: String

prevForceFullDisplay

open override var prevForceFullDisplay: Boolean

prevMainHeightWidth

var prevMainHeightWidth: Double

prevMeetingDisplayType

open override var prevMeetingDisplayType: String

prevScreenStates

open override var prevScreenStates: List<ScreenState>

prevVideoInputDevice

var prevVideoInputDevice: String

processedStream

var processedStream: MediaStream?

producerTransport

var producerTransport: WebRtcTransport?

progressTimerValue

var progressTimerValue: Int

progressTimerVisible

var progressTimerVisible: Boolean

recordChangeSeconds

var recordChangeSeconds: Int

recordElapsedTime

open override var recordElapsedTime: Int

recordingAddHLS

var recordingAddHLS: Boolean

recordingAddText

var recordingAddText: Boolean

recordingAllParticipantsFullRoomSupport

var recordingAllParticipantsFullRoomSupport: Boolean

recordingAllParticipantsSupport

var recordingAllParticipantsSupport: Boolean

recordingAudioOptions

var recordingAudioOptions: String

recordingAudioParticipantsTimeLimit

var recordingAudioParticipantsTimeLimit: Int

recordingAudioPausesCount

var recordingAudioPausesCount: Int

recordingAudioPausesLimit

var recordingAudioPausesLimit: Int

recordingAudioPeopleLimit

var recordingAudioPeopleLimit: Int

recordingAudioSupport

var recordingAudioSupport: Boolean

recordingBackgroundColor

var recordingBackgroundColor: String

recordingCustomText

var recordingCustomText: String

recordingCustomTextColor

var recordingCustomTextColor: String

recordingCustomTextPosition

var recordingCustomTextPosition: String

recordingDisplayType

open override var recordingDisplayType: String

recordingMediaOptions

var recordingMediaOptions: String

recordingMultiFormatsSupport

var recordingMultiFormatsSupport: Boolean

recordingNameTags

var recordingNameTags: Boolean

recordingNameTagsColor

var recordingNameTagsColor: String

recordingOrientationVideo

var recordingOrientationVideo: String

recordingPreferredOrientation

var recordingPreferredOrientation: String

recordingProgressTime

var recordingProgressTime: String

recordingSupportForOtherOrientation

var recordingSupportForOtherOrientation: Boolean

recordingVideoOptimized

open override var recordingVideoOptimized: Boolean

recordingVideoOptions

var recordingVideoOptions: String

recordingVideoParticipantsFullRoomSupport

var recordingVideoParticipantsFullRoomSupport: Boolean

recordingVideoParticipantsSupport

var recordingVideoParticipantsSupport: Boolean

recordingVideoParticipantsTimeLimit

var recordingVideoParticipantsTimeLimit: Int

recordingVideoPausesCount

var recordingVideoPausesCount: Int

recordingVideoPausesLimit

var recordingVideoPausesLimit: Int

recordingVideoPeopleLimit

var recordingVideoPeopleLimit: Int

recordingVideoSupport

var recordingVideoSupport: Boolean

recordingVideoType

var recordingVideoType: String

recordPaused

open override var recordPaused: Boolean

recordResumed

open override var recordResumed: Boolean

recordStarted

open override var recordStarted: Boolean

recordStartTime

open override var recordStartTime: Long?

recordState

var recordState: String

recordStopped

open override var recordStopped: Boolean

recordTimerInterval

var recordTimerInterval: Any?

recordTimerJob

var recordTimerJob: Job?

recvTransport

var recvTransport: WebRtcTransport?

redirectURL

var redirectURL: String

redoStack

var redoStack: List<WhiteboardShape>

refParticipants

var refParticipants: List<Participant>

remoteScreenStream

open override var remoteScreenStream: List<Stream>

remoteScreenStreamState

var remoteScreenStreamState: List<Stream>

removeAltGrid

var removeAltGrid: Boolean

reorderInterval

open override var reorderInterval: Int

reorderStreams

open override val reorderStreams: suspend (ReorderStreamsOptions) -> Unit

rePort

open override val rePort: suspend (RePortOptions) -> Unit

requestCounter

var requestCounter: Int

requestFilter

var requestFilter: String

requestList

var requestList: List<Request>

requestPermissionAudio

var requestPermissionAudio: RequestPermissionAudioType?

requestPermissionCamera

var requestPermissionCamera: RequestPermissionCameraType?

requestScreenCapturePermission

var requestScreenCapturePermission: RequestScreenCapturePermissionType?

Callback to request screen capture permission. On Android, this should request MediaProjection permission and return mapOf("resultCode" to resultCode, "data" to data) on success, or null on denial.

reUpdateInter