Quick Start

Get the Vio Kotlin SDK running in your Android app in under 5 minutes.

1. Add the Dependency

In your app-level build.gradle.kts:


dependencies {
    implementation("live.vio:vio-kotlin-sdk:1.0.0-alpha")
}

2. Initialize at Startup

In your Application class, initialize the SDK:


import android.app.Application
import live.vio.sdk.VioSDK
 
class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
 
        // Zero-config: initialize with just your API key
        VioSDK.configure(
            context = this,
            apiKey = "your-api-key"
        )
    }
}

3. Connect to a Broadcast

Call VioSDK.setContent(id) when the user opens a stream. The id is the externalId of the broadcast configured in the Dashboard:


// When the user opens a stream
VioSDK.setContent(contentId = "your-broadcast-id")

4. Add a Product Card


import androidx.compose.runtime.Composable
import live.vio.VioUI.Components.VioProductCarousel
 
@Composable
fun ProductListScreen() {
    VioProductCarousel(
        channelId = "your-channel-id",
        onProductClick = { product ->
            // Handle product selection
        }
    )
}

4. Run Your App

Build and run. You should see the product carousel rendered with Vio styling.

What’s Next?

Installation — Detailed Gradle setup and permissions
Configuration — Environment, themes, and options
Core Concepts — Understand the SDK architecture