shared/com.mediasfu.sdk.methods.utils

Package-level declarations

Types

data class CheckLimitsAndMakeRequestOptions(val apiUserName: String, val apiToken: String, val link: String, val userName: String, val parameters: CheckLimitsAndMakeRequestParameters, val validate: Boolean = true)

Options for checking limits and making requests.

CheckLimitsAndMakeRequestParameters

interface CheckLimitsAndMakeRequestParameters

Parameters for checking limits and making requests.

CreateJoinRoomError

@Serializable

data class CreateJoinRoomError(val error: String, val success: Boolean? = null)

Represents the error response from creating or joining a room.

CreateJoinRoomResponse

@Serializable

data class CreateJoinRoomResponse(val message: String, val roomName: String, val secureCode: String? = null, val publicURL: String, val link: String, val secret: String, val success: Boolean)

Represents the successful response from creating or joining a room.

CreateJoinRoomResult

data class CreateJoinRoomResult(val data: Any? = null, val success: Boolean)

Aggregates the result from attempting to create or join a room. Mirrors the Flutter SDK where the payload may be either a success response, an error response, or null when the request fails early.

CreateJoinRoomType

typealias CreateJoinRoomType = suspend (payload: Map<String, Any?>, apiUserName: String, apiKey: String) -> CreateJoinRoomResult

Signature for functions that create or join a MediaSFU room.

CreateMediaSFUOptions

data class CreateMediaSFUOptions(val payload: CreateMediaSFURoomOptions, val apiUserName: String, val apiKey: String, val localLink: String = "")

Options for creating a room on MediaSFU.

CreateMediaSFURoomOptions

@Serializable

data class CreateMediaSFURoomOptions(val action: String, val duration: Int, val capacity: Int, val userName: String, val scheduledDate: Long? = null, val secureCode: String? = null, val eventType: String? = null, val roomName: String? = null, val adminPasscode: String? = null, val islevel: String? = null, val recordOnly: Boolean? = false, val safeRoom: Boolean? = false, val autoStartSafeRoom: Boolean? = false, val safeRoomAction: String? = "kick", val dataBuffer: Boolean? = false, val bufferType: String? = "all")

Options for creating a room on MediaSFU.

CreateResponseJoinRoomOptions

data class CreateResponseJoinRoomOptions(val localRoom: ResponseJoinLocalRoom)

Represents the options for creating a ResponseJoinRoom.

FormatNumberOptions

data class FormatNumberOptions(val number: Int)

Options for the formatNumber function.

FormatNumberType

typealias FormatNumberType = suspend (FormatNumberOptions) -> String?

Type definition for the formatNumber function.

GenerateRandomMessagesOptions

data class GenerateRandomMessagesOptions(val participants: List<Participant>, val member: String, val coHost: String? = null, val host: String, val forChatBroadcast: Boolean = false)

Options for generating random messages.

GenerateRandomMessagesType

typealias GenerateRandomMessagesType = (GenerateRandomMessagesOptions) -> List<Message>

Type definition for the random message generator function.

GenerateRandomParticipantsOptions

data class GenerateRandomParticipantsOptions(val member: String, val coHost: String? = null, val host: String, val forChatBroadcast: Boolean = false)

Options for generating a random list of participants.

GenerateRandomParticipantsType

typealias GenerateRandomParticipantsType = (GenerateRandomParticipantsOptions) -> List<Participant>

Type definition for the participant generator function.

GenerateRandomPollsOptions

data class GenerateRandomPollsOptions(val numberOfPolls: Int)

Options for generating random polls.

GenerateRandomPollsType

typealias GenerateRandomPollsType = (GenerateRandomPollsOptions) -> List<Poll>

Type definition for the poll generator function.

GenerateRandomRequestListOptions

data class GenerateRandomRequestListOptions(val participants: List<Participant>, val hostName: String, val coHostName: String? = null, val numberOfRequests: Int)

Options for generating a random request list.

GenerateRandomRequestListType

typealias GenerateRandomRequestListType = (GenerateRandomRequestListOptions) -> List<Request>

Type definition for the request list generator function.

GenerateRandomWaitingRoomListType

typealias GenerateRandomWaitingRoomListType = () -> List<WaitingRoomParticipant>

Type definition for the waiting room list generator function.

GetMediaDevicesListType

typealias GetMediaDevicesListType = suspend (String) -> List<MediaDeviceInfo>

Type definition for the getMediaDevicesList function.

GetModalPositionOptions

data class GetModalPositionOptions(val position: String, val modalWidth: Double, val modalHeight: Double, val screenWidth: Double, val screenHeight: Double)

Options for configuring the modal position.

GetModalPositionType

typealias GetModalPositionType = (GetModalPositionOptions) -> Map<String, Double>

Type definition for get modal position function.

GetOverlayPositionOptions

data class GetOverlayPositionOptions(val position: String)

Options for configuring the overlay position.

GetOverlayPositionType

typealias GetOverlayPositionType = (GetOverlayPositionOptions) -> Map<String, Any>

Type definition for get overlay position function.

GetParticipantMediaOptions

data class GetParticipantMediaOptions(val id: String = "", val name: String = "", val kind: String = "video", val parameters: GetParticipantMediaParameters)

Options for the getParticipantMedia function.

GetParticipantMediaParameters

interface GetParticipantMediaParameters

Parameters interface for getParticipantMedia.

GetParticipantMediaType

typealias GetParticipantMediaType = suspend (GetParticipantMediaOptions) -> MediaStream?

Type definition for the getParticipantMedia function.

InitialValues

object InitialValues

Initial values for the MediaSFU SDK state.

JoinMediaSFUOptions

data class JoinMediaSFUOptions(val payload: JoinMediaSFURoomOptions, val apiUserName: String, val apiKey: String, val localLink: String = "")

Options for joining a room on MediaSFU.

JoinMediaSFURoomOptions

@Serializable

data class JoinMediaSFURoomOptions(val action: String, val meetingID: String, val userName: String, val adminPasscode: String? = null, val islevel: String = "0")

Options for joining a room on MediaSFU.

PlatformAudioPlayer

actual class PlatformAudioPlayer

expect class PlatformAudioPlayer

Platform-agnostic interface for audio playback. Platform-specific implementations should be provided via expect/actual.

SleepOptions

data class SleepOptions(val ms: Long)

Options for the sleep function, containing the sleep duration in milliseconds.

SleepType

typealias SleepType = suspend (SleepOptions) -> Unit

Type definition for sleep function.

SoundPlayer

object SoundPlayer

A sound player that plays audio from a given URL.

SoundPlayerOptions

data class SoundPlayerOptions(val soundUrl: String)

Options for the SoundPlayer, encapsulating the sound URL.

SoundPlayerType

typealias SoundPlayerType = suspend (SoundPlayerOptions) -> Unit

Type definition for sound player function.

ValidateAlphanumericOptions

data class ValidateAlphanumericOptions(val str: String)

Options for the alphanumeric validation, containing the string to validate.

ValidateAlphanumericType

typealias ValidateAlphanumericType = suspend (ValidateAlphanumericOptions) -> Boolean

Type definition for alphanumeric validation function.

Functions

checkLimitsAndMakeRequest

suspend fun checkLimitsAndMakeRequest(options: CheckLimitsAndMakeRequestOptions)

Checks for rate limits and establishes a socket connection if permissible.

createJoinRoom

suspend fun createJoinRoom(payload: Map<String, Any?>, apiUserName: String, apiKey: String): CreateJoinRoomResult

Resolves the loosely typed payload into the correct REST helper call. This mirrors the behaviour of the Flutter SDK by accepting dynamic maps and normalising the values before delegating to createRoomOnMediaSfu or joinRoomOnMediaSfu.

createResponseJoinRoom