mediasfu-sdk-kotlin

Real-time video conferencing SDK offering drop-in UI, customizable components, screen sharing, recording, chat, participant management, breakout rooms, polls, pagination, and self-hosting support.

#ui
#sdk
#gradle
#design-system
#client
#audio

Suggest an edit

Android JVMKotlin/Native

GitHub stars0

AuthorsMediaSFU

Open issues0

LicenseMIT License

Creation date2 months ago

Last activity28 days ago

Latest release1.0.1 (28 days ago)

GitHub repository Wiki page

MediaSFU Kotlin SDK

Real-time video conferencing for Android & Kotlin Multiplatform — drop-in solution with pre-built UI or full customization.

📖 Full Documentation → | 🌐 mediasfu.com

⚡ Quick Start (2 Minutes)

1. Add Dependency

// build.gradle.kts (app level)
dependencies {
    // For Android-only projects (recommended):
    implementation("com.mediasfu:mediasfu-sdk-android:1.0.0")
    
    // For Kotlin Multiplatform projects:
    // implementation("com.mediasfu:mediasfu-sdk:1.0.0")
}

2. Use It

import com.mediasfu.sdk.ui.mediasfu.MediasfuGeneric
import com.mediasfu.sdk.ui.mediasfu.MediasfuGenericOptions
import com.mediasfu.sdk.model.Credentials

@Composable
fun App() {
    // Option 1: No credentials (testing/demo)
    MediasfuGeneric()
    
    // Option 2: With MediaSFU Cloud credentials
    // MediasfuGeneric(
    //     options = MediasfuGenericOptions(
    //         credentials = Credentials(apiUserName = "your_username", apiKey = "your_api_key")
    //     )
    // )
}

3. Run

./gradlew :androidApp:installDebug

Done! You have a full-featured video conferencing app with:

✅ Video & audio streaming
✅ Screen sharing
✅ Chat messaging
✅ Participant management
✅ Recording capabilities
✅ Breakout rooms & polls

📦 Installation

Gradle (Kotlin DSL)

dependencies {
    // For Android-only projects (recommended):
    implementation("com.mediasfu:mediasfu-sdk-android:1.0.0")
    
    // For Kotlin Multiplatform projects:
    // implementation("com.mediasfu:mediasfu-sdk:1.0.0")
}

Android Permissions

Add to AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />

🎯 Room Types

All room types are convenience wrappers around MediasfuGeneric with pre-configured event types:

Type	Default Event Type	Use Case
`MediasfuGeneric`	`CONFERENCE`	General meetings
`MediasfuBroadcast`	`BROADCAST`	Live streaming
`MediasfuWebinar`	`WEBINAR`	Educational sessions
`MediasfuConference`	`CONFERENCE`	Business meetings
`MediasfuChat`	`CHAT`	Chat-focused

import com.mediasfu.sdk.ui.mediasfu.*
import com.mediasfu.sdk.model.Credentials

val options = MediasfuGenericOptions(
    credentials = Credentials(apiUserName = "user", apiKey = "key")
)

// Pick the right one for your use case - all use the same options!
MediasfuWebinar(options = options)
MediasfuBroadcast(options = options)
MediasfuConference(options = options)

🧩 Components (Flutter/React-like API)

Import and use components directly — no boilerplate:

import com.mediasfu.sdk.ui.AudioGrid
import com.mediasfu.sdk.ui.FlexibleGrid
import com.mediasfu.sdk.ui.components.display.AudioGridOptions
import com.mediasfu.sdk.ui.components.display.FlexibleGridOptions

@Composable
fun CustomLayout(parameters: MediasfuParameters) {
    // Just like Flutter/React!
    AudioGrid(AudioGridOptions(
        participants = parameters.participants,
        columnsPerRow = 3
    ))
    
    FlexibleGrid(FlexibleGridOptions(
        parameters = parameters,
        columns = 2
    ))
}

Available Components

Component	Description
`AudioGrid`	Audio participant grid
`AudioCard`	Single audio participant
`FlexibleGrid`	Flexible video grid
`FlexibleVideo`	Main video display
`MiniCard`	Compact participant card
`Pagination`	Page controls
`AlertComponent`	Alert messages
`MainAspectComponent`	Layout container

🎨 Customization Modes

Mode 1: Default UI (Easiest)

@Composable
fun App() {
    MediasfuGeneric(options = options)
}

Mode 2: Custom UI with MediaSFU Backend

@Composable
fun App() {
    var parameters by remember { mutableStateOf<MediasfuParameters?>(null) }
    
    // Hidden MediaSFU backend
    MediasfuGeneric(
        options = options.copy(returnUI = false),
        onParametersUpdate = { parameters = it }
    )
    
    // Your custom UI
    parameters?.let { params ->
        Column {
            Text("Room: ${params.roomName}")
            Button(onClick = { params.clickVideo(params) }) {
                Text(if (params.videoAlreadyOn) "Stop Video" else "Start Video")
            }
        }
    }
}

Mode 3: Replace Specific Components

@Composable
fun CustomMainScreen(parameters: MediasfuParameters) {
    Column {
        FlexibleVideo(FlexibleVideoOptions(parameters = parameters))
        FlexibleGrid(FlexibleGridOptions(parameters = parameters))
    }
}

MediasfuGeneric(
    options = options,
    customComponent = { CustomMainScreen(it) }
)

🔧 Key Methods

// Media controls
parameters.clickVideo(parameters)       // Toggle video
parameters.clickAudio(parameters)       // Toggle audio
parameters.clickScreenShare(parameters) // Toggle screen share

// State
parameters.videoAlreadyOn              // Boolean
parameters.audioAlreadyOn              // Boolean
parameters.participants                // List<Participant>

// Modals
parameters.updateIsParticipantsModalVisible(true)
parameters.updateIsMessagesModalVisible(true)

🏠 Self-Hosting

No API key needed for self-hosting. Use MediaSFU Open:

import com.mediasfu.sdk.ui.mediasfu.MediasfuGeneric
import com.mediasfu.sdk.ui.mediasfu.MediasfuGenericOptions

MediasfuGeneric(
    options = MediasfuGenericOptions(
        connectMediaSFU = false,
        localLink = "http://your-server:3000"
    )
)

📚 More Resources

Full Documentation — Complete API reference, all components, methods
mediasfu.com — Official docs
Community Forum — Get help
GitHub — Source code

📄 License

MIT © MediaSFU