Android Quick Start

This guide shows the fastest path from an Android project to a minimal Vizbl AR scene.

Before you start

You need:

• Android Studio.
• A physical Android device with AR support.
• Camera permission in the app.
• GitHub Packages access for the SDK.
• A Vizbl object tinuuid from connection.vizbl.com.

1. Add the SDK repository

Add the GitHub Packages repository to settings.gradle.kts.

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.pkg.github.com/VIZBL/vizbl-android-sdk")
            credentials {
                username = "YOUR_GITHUB_USERNAME"
                password = "YOUR_GITHUB_TOKEN"
            }
        }
    }
}

2. Add the dependency

Add the SDK dependency to your app module.

dependencies {
    implementation("com.vizbl:sdk:VERSION")
}

Replace VERSION with the SDK version provided by Vizbl.

3. Add your object tinuuid

Open your object in connection.vizbl.com and copy its tinuuid.

Replace your-tinuuid in the example below with that value before running the app. The SDK needs a real tinuuid to load your object.

4. Create a minimal AR screen

Render the AR scene (VizblARScene), wait for the AR controller (VizblARController), then add the object when the AR session is ready.

@Composable
fun ARScreen() {
    var controller by remember { mutableStateOf<VizblARController?>(null) }
    val scope = rememberCoroutineScope()

    VizblARScene(
        onControllerReady = { controller = it },
        onSessionReady = {
            val model = ARObjectReference.Single(
                id = ARObjectIdentifier.Tinuuid("your-tinuuid"),
                materialId = null
            )

            scope.launch {
                controller?.add(model)
            }
        }
    )
}

5. Run on a device

Build the app and run it on a physical AR-compatible Android device. When the AR scene opens, the SDK starts the AR flow and guides the user through placement.

Demo project

A working Android demo project is available on GitHub:

https://github.com/VIZBL/vizbl-android-demo

Next steps

• Pass Material ID (materialId) when you want to open a specific material.
• Add a VizblActionHandler when your app needs to respond to built-in AR control actions such as close, buy, add, confirm, delete, screenshot, or QR scan.
• Use controller.remove(...), controller.removeAll(), or controller.replace(...) when your app needs object management controls.