Skip to main content

XR8

Description

Entry point for 8th Wall's Javascript API

Functions

FunctionDescription
addCameraPipelineModuleAdds a module to the camera pipeline that will receive event callbacks for each stage in the camera pipeline.
addCameraPipelineModulesAdd multiple camera pipeline modules. This is a convenience method that calls addCameraPipelineModule in order on each element of the input array.
clearCameraPipelineModulesRemove all camera pipeline modules from the camera loop.
initializeReturns a promise that is fulfilled when the AR Engine's WebAssembly is initialized.
isInitializedIndicates whether or not the AR Engine's WebAssembly is initialized.
isPausedIndicates whether or not the XR session is paused.
pausePause the current XR session. While paused, the camera feed is stopped and device motion is not tracked.
resumeResume the current XR session.
removeCameraPipelineModuleRemoves a module from the camera pipeline.
removeCameraPipelineModulesRemove multiple camera pipeline modules. This is a convenience method that calls removeCameraPipelineModule in order on each element of the input array.
requiredPermissionsReturn a list of permissions required by the application.
runOpen the camera and start running the camera run loop.
runPreRenderExecutes all lifecycle updates that should happen before rendering.
runPostRenderExecutes all lifecycle updates that should happen after rendering.
stopStop the current XR session. While stopped, the camera feed is closed and device motion is not tracked.
versionGet the 8th Wall Web engine version.

Events

Event EmittedDescription
xrloadedThis event is emitted once XR8 has loaded.