Vizbl SDK

A lightweight AR SDK for embedding an augmented reality scene in your app.

Overview

Use VizblARScene to render the AR scene and optional overlay controls. Configure behavior with ARViewConfiguration and ARObjectConfiguration.

After initializing the scene, use the VizblARController to orchestrate your AR experience. It serves as the primary auxiliary layer providing a comprehensive suite of methods for managing the AR scene, lifecycle, and 3D model manipulation (such as adding, removing, and interacting with objects).

Features

• Controller (VizblARController) defines the control surface for placing, selecting, and managing AR content.

• View (VizblARScene) is a Composable function that renders the AR scene and UI overlays.

• Simple, type-safe configuration via ARViewConfiguration and ARObjectConfiguration.

• Handle user input through the VizblActionHandler interface.

Public API Surface

• VizblARController

• add

• placedObjects

• selectedInstanceId

• VizblARScene

• ARViewConfiguration

• ARObjectConfiguration

• ARObjectReference

Architecture

Vizbl SDK is organized into three layers:

• Controller: VizblARController serves as the primary auxiliary orchestrator, providing the control surface for placing, selecting, and managing AR content through various scene manipulation methods.

• View: VizblARScene is a Composable that renders the AR scene and optional overlay controls.

• Configuration & Models: ARViewConfiguration and ARObjectConfiguration describe runtime behavior.

Typical usage

    import com.us.vizbl.ar.sdk.api.VizblARController
    import com.us.vizbl.ar.sdk.api.VizblARScene
    
    @Composable
    fun MainScreen(){ 
        var controller by remember { mutableStateOf<VizblARController?>(null) }
        
        VizblARScene(
            onControllerReady = {
                controller = it
            },
            model = ARObjectReference.Single(ARObjectIdentifier.ObjectId("d6742149-c4df-4ab5-81f4-233d31670284")),
            actionHandler = object : VizblActionHandler {
              override fun onCloseClick() {
                controller?.dismiss()
                activity.finish()
              }
            }
        )
    }
)