joinRoomOnMediaSfu

Sends a request to join an existing room on MediaSFU.

This function validates the provided credentials and dynamically determines the endpoint based on the localLink. It performs an HTTP POST request with the provided payload and returns the response or an error.

Parameters:

  • payload (JoinMediaSFURoomOptions): The payload containing room join details.

  • apiUserName (String): The API username used for authentication.

  • apiKey (String): The API key for authentication (must be exactly 64 characters).

  • localLink (String, optional): A local link for community edition servers.

Returns:

  • A CreateJoinRoomResult containing:

  • success (Boolean): Indicates whether the request was successful.

  • data (CreateJoinRoomResponse | CreateJoinRoomError): The response data or error details.

Example Usage:

val payload = JoinMediaSFURoomOptions(
action = "join",
meetingID = "testRoom123",
userName = "user123",
adminPasscode = "admin123",
islevel = "0"
)

val options = JoinMediaSFUOptions(
payload = payload,
apiUserName = "username",
apiKey = "your-64-character-api-key",
localLink = ""
)

val result = joinRoomOnMediaSfu(options)

Platform Notes:

  • Android: Uses Android HTTP client

  • iOS: Uses iOS HTTP client

  • Common: Platform-agnostic interface

Return

CreateJoinRoomResult containing success status and response data

Parameters

options

Configuration options for joining a room on MediaSFU