spatialml:securemr/com.pico.spatial.ml.securemr/SpatialMLSession

SpatialMLSession

@RequiresApi(value = 27)

class SpatialMLSession : BaseHandle

A handle to each session of SpatialML framework usage. For each session, a dedicated SpatialML container for securely rendering mixed-reality components will be allocated.

One session handle must be linked to a SpatialMLInstance, on which the framework session's lifecycle depends.

Parameters

instance

the SpatialMLInstance the session is associated with.

config

the configuration during initialization.

Throws

SpatialMLException

If the usage is not allowed by the SpatialML run-time Framework, or if the framework encounter internal error and cannot perform the requested behavior.

Types

object Companion

Companion for SpatialMLSession.

class InitInfo(val imageWidth: Int, val imageHeight: Int, val containerWidth: Int, val containerHeight: Int, val containerDepth: Int)

Configuration structure for framework session handle.

Properties

open override val destructor: BaseHandle.HandleDestructor

The BaseHandle's implementation's destructor.

Functions

newGlobalTensor

fun newGlobalTensor(config: Tensor.InitInfo): GlobalTensor

Create new global tensors within the context of current framework session.

fun newPipeline(): Pipeline

Create a new pipeline within the context of current framework session.

newSceneFromGLTF

fun newSceneFromGLTF(gltfSceneMemory: SharedMemory): GlobalTensor

Create an SpatialML scene from a glTF file already loaded into SharedMemory.

fun newSceneFromGLTF(gltfSceneAsset: String): GlobalTensor

Create an SpatialML scene from a glTF file in asset.

newSceneFromGLTFSuspend

suspend fun newSceneFromGLTFSuspend(gltfSceneAsset: String): GlobalTensor

Async version of newSceneFromGLTF.