AppSystemService serves as the base class for all Spatial SDK services. It contains all Android service lifecycle callbacks: onCreate, onDestroy, and others. It also provides scene lifecycle callbacks: onSceneReady and onSceneTick. This class also provides hooks to override system features through registerSystemFeatures and to register panels through registerPanels.

Signature

open class AppSystemService : VrService, AppSystemCommon, SpatialViewModelOwner

Constructors

AppSystemService ()

Signature

constructor()

Returns

AppSystemService

Properties

componentManager : ComponentManager [Get]	Signature val componentManager: ComponentManager
glXFManager : GLXFManager [Get]	Signature val glXFManager: GLXFManager
panelRegistrations : HashMap<Int, PanelRegistration> [Get]	Signature val panelRegistrations: HashMap<Int, PanelRegistration>
registeredReceivers : List [Get][Set]	Signature var registeredReceivers: List
scene : Scene [Get]	Signature val scene: Scene
systemManager : SystemManager [Get]	Signature val systemManager: SystemManager
viewModels : MutableSet [Get]	Signature open override val viewModels: MutableSet<SpatialViewModel>

Methods

doFrame ( frameTimeNanos )	Signature open fun doFrame(frameTimeNanos: Long) Parameters `frameTimeNanos: Long`
findFeature ( clazz )	Signature fun <T : SpatialFeature> findFeature(clazz: KClass<T>): T Parameters `clazz: KClass` Returns `VrService`
findFeature ()	Signature inline fun <T : SpatialFeature> findFeature(): T Returns `VrService`
getComponentManager ()	Signature fun getComponentManager(): ComponentManager Returns `ComponentManager`
getDataModel ()	Signature fun getDataModel(): DataModel Returns `DataModel`
getSceneObject ()	Signature fun getSceneObject(): Scene Returns `Scene`
getSystemManager ()	Signature fun getSystemManager(): SystemManager Returns `SystemManager`
onBind ( intent )	Signature open fun onBind(intent: Intent): IBinder Parameters `intent: Intent` Returns `IBinder`
onCreate ()	Called when the service is first created. Override this lifecycle callback method to do all of your normal static set up: creating views, setting the content view, register Components as well as Systems and etc. You can also perform dynamic setup, such as querying for data and loading it into the view. This will also be called for all activities that are restored to their state when last paused or stopped. If you override this method, be sure to call super.onCreate(). Signature open override fun onCreate()
onDestroy ()	Called when the service is destroyed. Override this method to perform any final cleanup. If you override this method, be sure to call super.onDestroy() Note: This is not guaranteed to be called, as the OS may kill the service's hosting process at any time. Signature open override fun onDestroy()
onHMDMounted ()	Signature open fun onHMDMounted()
onHMDUnmounted ()	Signature open fun onHMDUnmounted()
onRebind ( intent )	Signature open fun onRebind(intent: Intent) Parameters `intent: Intent`
onRecenter ( isUserInitiated )	Signature open fun onRecenter(isUserInitiated: Boolean) Parameters `isUserInitiated: Boolean`
onSceneReady ()	This hook is called on the first onResume(), after the scene is loaded in onCreate(). This is where you should call the scene APIs such as setReferenceSpace to define your scene. If you override this method, be sure to call super.onSceneReady(). Signature open override fun onSceneReady()
onSceneTick ()	Called every tick in the application. It is advisable to use this lifecycle callback method sparingly and to create Systems that manage logic in every tick. If you override this method, be sure to call super.onSceneTick(). Signature open override fun onSceneTick()
onSessionStateChanged ( state )	Called when the OpenXR session state changes. This callback is invoked whenever the XR runtime transitions between different session states. Applications can override this method to respond to state changes, such as preparing resources when the session becomes ready, or pausing rendering when losing focus. Signature open fun onSessionStateChanged(state: SessionState) Parameters `state: SessionState` The new session state
onStartCommand ( intent , flags , startId )	Signature open fun onStartCommand(intent: Intent, flags: Int, startId: Int): Int Parameters `intent: Intent` `flags: Int` `startId: Int` Returns `Int`
onUnbind ( intent )	Signature open fun onUnbind(intent: Intent): Boolean Parameters `intent: Intent` Returns `Boolean`
onVRPause ()	Signature open fun onVRPause()
onVRReady ()	Signature open fun onVRReady()
registerAsyncMeshCreator ( baseUrl , creator )	Registers an async mesh creator for a base URL pattern. Unlike AppSystemCommon.registerMeshCreator, the creator function will be invoked on a background thread. The resulting SceneMesh will be attached to the entity on the main thread. This is suitable for mesh creators that perform expensive computation (e.g., procedural geometry generation). The creator will be invoked for any mesh URI that matches the base URL (scheme + authority + path). Query parameters from the full URI will be passed to the creator for customization. Parameters `baseUrl: String` The base URL to match (e.g., "mesh://myapp/custom"). Query parameters are ignored in matching. `creator: SuspendFunction2` Function that takes an Entity and the full URI (including query params), returns a SceneMesh. Called on a background thread.
registerFeatures ()	Signature open fun registerFeatures(): List<SpatialFeature> Returns `List`
registerMeshCreator ( baseUrl , creator )	Registers a mesh creator for a base URL pattern. The creator will be invoked for any mesh URI that matches the base URL (scheme + authority + path). Query parameters from the full URI will be passed to the creator for customization. Example: // Register a creator for "mesh://custom/sphere" registerMeshCreator("mesh://custom/sphere") { entity, uri -> val radius = uri.getQueryParameter("radius")?.toFloatOrNull() ?: 1.0f val color = uri.getQueryParameter("color") ?: "white" createSphere(entity, radius, color) } // Later, use with parameters: Mesh(Uri.parse("mesh://custom/sphere?radius=2.5&color=red")) Parameters `baseUrl: String` The base URL to match (e.g., "mesh://myapp/custom"). Query parameters are ignored in matching. `creator: Function2` Function that takes an Entity and the full URI (including query params), returns a SceneMesh
registerMeshCreator ( meshURL , creator )	Registers a simple mesh creator that doesn't need URI parameters. This is a convenience method for mesh creators that don't need to read query parameters from the URI. The mesh URL must match exactly. Example: registerMeshCreator("mesh://custom") { entity -> SceneMesh.box(-0.5f, -0.5f, -0.5f, 0.5f, 0.5f, 0.5f, material) } Signature open fun registerMeshCreator(meshURL: String, creator: (entity: Entity) -> SceneMesh) Parameters `meshURL: String` The exact mesh URL to match `creator: Function1` Function that takes an Entity and returns a SceneMesh
registerPanel ( panelRegistration )	This is used to register a panel. This is called within the onCreate lifecycle for every PanelRegistration returned by registerPanels. It is strongly discouraged to call this directly to dynamically register panels, as panels should be registered during OnCreate() Signature fun registerPanel(panelRegistration: PanelRegistration) Parameters `panelRegistration: PanelRegistration`
registerPanels ()	This hook is where you should register your panels. This is called within the onCreate lifecycle. Signature open fun registerPanels(): List<PanelRegistration> Returns `List`
registerSystemFeatures ()	This hook is where the application registers SystemFeatures such as ToolkitFeature. This is called within the onCreate lifecycle. Note that to register a custom SpatialFeature, override registerFeatures instead. Signature open override fun registerSystemFeatures(): List<SpatialFeature> Returns `List`
runOnMainThread ( runnable )	Signature fun runOnMainThread(runnable: Runnable) Parameters `runnable: Runnable`
setBaseHref ( baseHref )	Signature open fun setBaseHref(baseHref: String) Parameters `baseHref: String`
tryFindFeature ( clazz )	Signature fun <T : SpatialFeature> tryFindFeature(clazz: KClass<T>): T? Parameters `clazz: KClass` Returns `VrService?`
tryFindFeature ()	Signature inline fun <T : SpatialFeature> tryFindFeature(): T? Returns `VrService?`
unregisterAsyncMeshCreator ( baseUrl )	Unregisters an async mesh creator for the given base URL. Signature open fun unregisterAsyncMeshCreator(baseUrl: String) Parameters `baseUrl: String` The base URL that was registered
unregisterMeshCreator ( baseUrl )	Unregisters a mesh creator for the given base URL. Signature open fun unregisterMeshCreator(baseUrl: String) Parameters `baseUrl: String` The base URL that was registered