shared/com.mediasfu.sdk.socket

Package-level declarations

Types

enum ConnectionState : Enum<ConnectionState>

Connection state enum

data class ConnectLocalSocketOptions(val socket: SocketManager, val link: String, val config: SocketConfig = SocketConfig( reconnection = true, transports = listOf("websocket"), autoConnect = true ), val timeoutMillis: Long = 10000)

Parameters for connecting to the local Community Edition socket.

CreateJoinLocalRoomResponse

data class CreateJoinLocalRoomResponse(val success: Boolean, val secret: String, val reason: String? = null, val url: String? = null)

Simplified acknowledgment payload returned by local socket create/join operations.

CreateLocalRoomOptions

data class CreateLocalRoomOptions(val socket: SocketManager, val parameters: CreateLocalRoomParameters)

Wrapper for Community Edition create requests.

CreateLocalRoomParameters

data class CreateLocalRoomParameters(val eventId: String, val duration: Int, val capacity: Int, val userName: String, val scheduledDateIso: String, val secureCode: String, val waitRoom: Boolean? = null, val recordingParams: RecordingParams? = null, val eventRoomParams: MeetingRoomParams? = null, val videoPreference: String? = null, val audioPreference: String? = null, val audioOutputPreference: String? = null, val mediasfuURL: String? = null)

Parameters required when creating a Community Edition event locally.

JoinConRoomOptions

data class JoinConRoomOptions(val socket: SocketManager, val roomName: String, val islevel: String, val member: String, val sec: String, val apiUserName: String)

Options for joining a conference room.

JoinEventRoomOptions

data class JoinEventRoomOptions(val socket: SocketManager, val parameters: JoinEventRoomParameters)

Options wrapper for Community Edition join requests.

JoinEventRoomParameters

data class JoinEventRoomParameters(val eventId: String, val userName: String, val secureCode: String? = null, val videoPreference: String? = null, val audioPreference: String? = null, val audioOutputPreference: String? = null)

Parameters for joining a Community Edition event using the local socket.

JoinLocalRoomOptions

data class JoinLocalRoomOptions(val socket: SocketManager, val roomName: String, val islevel: String, val member: String, val sec: String, val apiUserName: String)

Options for joining a local room.

JoinRoomOptions

data class JoinRoomOptions(val socket: SocketManager, val roomName: String, val islevel: String, val member: String, val sec: String, val apiUserName: String)

Options for joining a standard room.

MeetingEndedOptions

data class MeetingEndedOptions(val showAlert: ShowAlert? = null, val redirectUrl: String? = null, val onWeb: Boolean, val eventType: EventType, val updateValidated: (Boolean) -> Unit? = null)

Kotlin replicas of mediasfu_sdk/lib/producers/socket_receive_methods meeting-related handlers.

MeetingStillThereOptions

data class MeetingStillThereOptions(val updateIsConfirmHereModalVisible: (Boolean) -> Unit)

MeetingTimeRemainingOptions

data class MeetingTimeRemainingOptions(val timeRemainingMillis: Int, val showAlert: ShowAlert? = null, val eventType: EventType)

ParticipantRequestedOptions

data class ParticipantRequestedOptions(val userRequest: Request, val requestList: List<Request>, val waitingRoomList: List<WaitingRoomParticipant>, val updateTotalReqWait: (Int) -> Unit, val updateRequestList: (List<Request>) -> Unit)

PersonJoinedOptions

data class PersonJoinedOptions(val name: String, val showAlert: ShowAlert? = null)

ReceiveMessageOptions

data class ReceiveMessageOptions(val message: Message, val messages: List<Message>, val participantsAll: List<Participant>, val member: String, val eventType: EventType, val isLevel: String, val coHost: String, val updateMessages: (List<Message>) -> Unit, val updateShowMessagesBadge: (Boolean) -> Unit)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/receive_message.dart.

ResponseJoinLocalRoom

data class ResponseJoinLocalRoom(val rtpCapabilities: RtpCapabilities? = null, val isHost: Boolean? = null, val eventStarted: Boolean? = null, val isBanned: Boolean? = null, val hostNotJoined: Boolean? = null, val eventRoomParams: MeetingRoomParams? = null, val recordingParams: RecordingParams? = null, val secureCode: String? = null, val mediasfuURL: String? = null, val apiKey: String? = null, val apiUserName: String? = null, val allowRecord: Boolean? = null)

Response received when joining a local room.

ResponseJoinRoom

data class ResponseJoinRoom(val rtpCapabilities: RtpCapabilities? = null, val success: Boolean? = false, val roomRecvIPs: List<String>? = null, val meetingRoomParams: MeetingRoomParams? = null, val recordingParams: RecordingParams? = null, val secureCode: String? = null, val recordOnly: Boolean? = null, val isHost: Boolean? = null, val safeRoom: Boolean? = null, val autoStartSafeRoom: Boolean? = null, val safeRoomStarted: Boolean? = null, val safeRoomEnded: Boolean? = null, val reason: String? = null, val banned: Boolean? = null, val suspended: Boolean? = null, val noAdmin: Boolean? = null)

Response received when joining a room.

ResponseLocalConnection

data class ResponseLocalConnection(val socket: SocketManager, val data: ResponseLocalConnectionData)

Container pairing the connected socket with its connection metadata.

ResponseLocalConnectionData

data class ResponseLocalConnectionData(val socketId: String?, val mode: String?, val apiUserName: String?, val apiKey: String?, val allowRecord: Boolean, val mediasfuURL: String?, val eventRoomParams: MeetingRoomParams?, val recordingParams: RecordingParams?, val raw: Map<String, Any?> = emptyMap())

Data emitted when the local socket reports a successful connection.

Socket

typealias Socket = SocketManager

Temporary alias retained for backwards compatibility while migrating call sites to SocketManager.

SocketDataConverter

actual object SocketDataConverter

Android implementation of data converter using JSONObject

SocketEmitException

class SocketEmitException(message: String, cause: Throwable? = null) : Exception

Exception thrown when socket emit operations fail.

SocketException

class SocketException(message: String, cause: Throwable? = null) : Exception

Custom exception for socket-related errors

SocketManager

interface SocketManager

Socket manager for handling real-time communication with MediaSFU servers.

SocketManagerImpl

class SocketManagerImpl : SocketManager

Android implementation of SocketManager

WhiteboardActionOptions

data class WhiteboardActionOptions(val action: String, val payload: Map<String, Any?>?, val shapes: List<WhiteboardShape>, val redoStack: List<List<WhiteboardShape>>, val undoStack: List<List<WhiteboardShape>>, val useImageBackground: Boolean, val updateShapes: (List<WhiteboardShape>) -> Unit, val updateRedoStack: (List<List<WhiteboardShape>>) -> Unit, val updateUndoStack: (List<List<WhiteboardShape>>) -> Unit, val updateUseImageBackground: (Boolean) -> Unit)

Options for handling whiteboard action events.

WhiteboardEndedOptions

data class WhiteboardEndedOptions(val updateWhiteboardStarted: (Boolean) -> Unit, val updateWhiteboardEnded: (Boolean) -> Unit, val updateShapes: (List<WhiteboardShape>) -> Unit)

Options for handling whiteboard ended events.

WhiteboardStartedOptions

data class WhiteboardStartedOptions(val whiteboardUsers: List<Map<String, Any?>>?, val updateWhiteboardUsers: (List<WhiteboardUser>) -> Unit, val updateWhiteboardStarted: (Boolean) -> Unit, val updateWhiteboardEnded: (Boolean) -> Unit)

Options for handling whiteboard started events.

WhiteboardUpdatedOptions

data class WhiteboardUpdatedOptions(val whiteboardUsers: List<Map<String, Any?>>?, val whiteboardData: Map<String, Any?>?, val status: String?, val updateWhiteboardUsers: (List<WhiteboardUser>) -> Unit, val updateShapes: (List<WhiteboardShape>) -> Unit, val updateWhiteboardStarted: (Boolean) -> Unit, val updateWhiteboardEnded: (Boolean) -> Unit, val shapes: List<WhiteboardShape>)

Options for handling whiteboard updated events.

Functions

allMembers

suspend fun allMembers(options: AllMembersOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/all_members.dart.

allMembersRest

suspend fun allMembersRest(options: AllMembersRestOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/all_members_rest.dart.

allWaitingRoomMembers

suspend fun allWaitingRoomMembers(options: AllWaitingRoomMembersOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/all_waiting_room_members.dart.

banParticipant

suspend fun banParticipant(options: BanParticipantOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/ban_participant.dart.

connectLocalSocket

suspend fun connectLocalSocket(options: ConnectLocalSocketOptions): Result<ResponseLocalConnection>

Establishes the local socket connection and waits for the success event.

controlMediaHost

suspend fun controlMediaHost(options: ControlMediaHostOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/control_media_host.dart.

createLocalRoom

suspend fun createLocalRoom(options: CreateLocalRoomOptions): Result<CreateJoinLocalRoomResponse>

Creates a Community Edition event via the local socket.

createSocketManager

actual fun createSocketManager(): SocketManager

Android implementation of SocketManager using Socket.IO Java client.

expect fun createSocketManager(): SocketManager

Factory function to create a SocketManager instance. Uses platform-specific implementations.

defaultMeetingRoomParams

fun defaultMeetingRoomParams(): MeetingRoomParams

Default Community Edition meeting configuration mirroring Flutter sample values.

defaultRecordingParams

fun defaultRecordingParams(): RecordingParams

Default Community Edition recording configuration used when server omits details.

disconnect

suspend fun disconnect(options: DisconnectOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/disconnect.dart.

disconnectUserSelf

suspend fun disconnectUserSelf(options: DisconnectUserSelfOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/disconnect_user_self.dart.

getDomains

suspend fun getDomains(options: GetDomainsOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/get_domains.dart.

handleWhiteboardAction

fun handleWhiteboardAction(options: WhiteboardActionOptions)

Process a whiteboard action from the socket.

handleWhiteboardEnded

fun handleWhiteboardEnded(options: WhiteboardEndedOptions)

Handle whiteboard ended event.

handleWhiteboardStarted

fun handleWhiteboardStarted(options: WhiteboardStartedOptions)

Handle whiteboard started event.

handleWhiteboardUpdated

fun handleWhiteboardUpdated(options: WhiteboardUpdatedOptions)

Handle whiteboard state updates from the server.

hostRequestResponse

suspend fun hostRequestResponse(options: HostRequestResponseOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/host_request_response.dart.

joinConRoom

suspend fun joinConRoom(options: JoinConRoomOptions): Result<ResponseJoinRoom>

Joins a conference room.

joinEventRoom

suspend fun joinEventRoom(options: JoinEventRoomOptions): Result<CreateJoinLocalRoomResponse>

Joins a Community Edition event room via the local socket.

joinLocalRoom

suspend fun joinLocalRoom(options: JoinLocalRoomOptions): Result<ResponseJoinLocalRoom>

Joins a local room.

joinRoom

suspend fun joinRoom(options: JoinRoomOptions): Result<ResponseJoinRoom>

Joins a standard media room.

meetingEnded

suspend fun meetingEnded(options: MeetingEndedOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/meeting_ended.dart.

suspend fun meetingEnded(options: MeetingEndedOptions)

meetingStillThere

suspend fun meetingStillThere(options: MeetingStillThereOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/meeting_still_there.dart.

fun meetingStillThere(options: MeetingStillThereOptions)

meetingTimeRemaining

suspend fun meetingTimeRemaining(options: MeetingTimeRemainingOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/meeting_time_remaining.dart.

fun meetingTimeRemaining(options: MeetingTimeRemainingOptions)

participantRequested

fun participantRequested(options: ParticipantRequestedOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/participant_requested.dart.

fun participantRequested(options: ParticipantRequestedOptions)

personJoined

fun personJoined(options: PersonJoinedOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/person_joined.dart.

fun personJoined(options: PersonJoinedOptions)

producerMediaClosed

suspend fun producerMediaClosed(options: ProducerMediaClosedOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/producer_media_closed.dart.

producerMediaPaused

suspend fun producerMediaPaused(options: ProducerMediaPausedOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/producer_media_paused.dart.

producerMediaResumed

suspend fun producerMediaResumed(options: ProducerMediaResumedOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/producer_media_resumed.dart.

receiveMessage

suspend fun receiveMessage(options: ReceiveMessageOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/receive_message.dart.

fun receiveMessage(options: ReceiveMessageOptions)

recordingNotice

suspend fun recordingNotice(options: RecordingNoticeOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/recording_notice.dart.

reInitiateRecording

suspend fun reInitiateRecording(options: ReInitiateRecordingOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/re_initiate_recording.dart.

roomRecordParams

fun roomRecordParams(options: RoomRecordParamsOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/room_record_params.dart.

screenProducerId

fun screenProducerId(options: ScreenProducerIdOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/screen_producer_id.dart.

startRecords

suspend fun startRecords(options: StartRecordsOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/start_records.dart.

stoppedRecording

suspend fun stoppedRecording(options: StoppedRecordingOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/stopped_recording.dart.

timeLeftRecording

fun timeLeftRecording(options: TimeLeftRecordingOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/time_left_recording.dart.

updateConsumingDomains

suspend fun updateConsumingDomains(options: UpdateConsumingDomainsOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/update_consuming_domains.dart.

updatedCoHost

fun updatedCoHost(options: UpdatedCoHostOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/updated_co_host.dart.

updateMediaSettings

fun updateMediaSettings(options: UpdateMediaSettingsOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/update_media_settings.dart.

userWaiting

fun userWaiting(options: UserWaitingOptions)

Kotlin replica of mediasfu_sdk/lib/producers/socket_receive_methods/user_waiting.dart.