Session

fun create(
    context: Context,
    coroutineContext: CoroutineContext = EmptyCoroutineContext,
    lifecycleOwner: LifecycleOwner = context as LifecycleOwner
): SessionCreateResult

Creates a new Session.

The thread on which this method should be called depends on the features being used:

• If you are using SceneCore rendering APIs, this method must be called on the Main Thread.

Thread Safety Warning: This method performs significant disk I/O, including loading native libraries. If StrictMode is enabled, calling this on the Main Thread (UI Thread) will trigger a android.os.StrictMode DiskReadViolation.

Example for calling on a WorkerThread for Projected devices:

lifecycleScope.launch {
    val result = withContext(Dispatchers.IO) {
        Session.create(context)
    }
}

fun configure(config: Config): SessionConfigureResult

Sets or changes the Config to use for the Session.

The passed config will overwrite all mode values. Not all runtimes will support every mode, and the desired modes should first be queried for availability using androidx.xr.runtime.XrDevice before configuring. Example: androidx.xr.runtime.XrDevice.isGeospatialModeSupported.

It is recommended to use and modify an instance of Config.Builder to maintain the current desired configuration state. A instance of Config to pass to this function can be created using Config.Builder.build.

Note that enabling most configurations will increase hardware resource consumption and should only be enabled if needed.

@GuardedBy(value = "lock")
val config: Config

The current state of the runtime configuration.

val context: Context

the Context the Session belongs to

val coroutineScope: CoroutineScope

the CoroutineScope for coroutines within the Session

val lifecycleOwner: LifecycleOwner

the owner of the Android Lifecycle the Session belongs to

val state: StateFlow<CoreState>

A StateFlow of the current state.

val Session.scene: Scene

Gets the Scene associated with this Session.

Accessing the scene in a destroyed activity can be dangerous.

The Scene is the primary interface for creating and managing spatial content. There is a single Scene instance for each Session.