Description

Entry point for 8th Wall's Javascript API

Functions

Function Description
addCameraPipelineModule Adds a module to the camera pipeline that will receive event callbacks for each stage in the camera pipeline.
addCameraPipelineModules Add multiple camera pipeline modules. This is a convenience method that calls addCameraPipelineModule in order on each element of the input array.
clearCameraPipelineModules Remove all camera pipeline modules from the camera loop.
initialize Returns a promise that is fulfilled when the AR Engine's WebAssembly is initialized.
isInitialized Indicates whether or not the AR Engine's WebAssembly is initialized.
isPaused Indicates whether or not the XR session is paused.
pause Pause the current XR session. While paused, the camera feed is stopped and device motion is not tracked.
resume Resume the current XR session.
removeCameraPipelineModule Removes a module from the camera pipeline.
removeCameraPipelineModules Remove multiple camera pipeline modules. This is a convenience method that calls removeCameraPipelineModule in order on each element of the input array.
requiredPermissions Return a list of permissions required by the application.
run Open the camera and start running the camera run loop.
runPreRender Executes all lifecycle updates that should happen before rendering.
runPostRender Executes all lifecycle updates that should happen after rendering.
stop Stop the current XR session. While stopped, the camera feed is closed and device motion is not tracked.
version Get the 8th Wall Web engine version.

Events

Event Emitted Description
xrloaded This event is emitted once XR8 has loaded.

Modules

Module Description
AFrame Entry point for A-Frame integration with 8th Wall Web.
Babylonjs Entry point for Babylon.js integration with 8th Wall Web.
CameraPixelArray Provides a camera pipeline module that gives access to camera data as a grayscale or color uint8 array.
CanvasScreenshot Provides a camera pipeline module that can generate screenshots of the current scene.
FaceController Provides face detection and meshing, and interfaces for configuring tracking.
GlTextureRenderer Provides a camera pipeline module that draws the camera feed to a canvas as well as extra utilities for GL drawing operations.
LayersController Provides a camera pipeline module that enables semantic layer detection and interfaces for configuring layer rendering.
MediaRecorder Provides a camera pipeline module that allows you to record a video in MP4 format.
PlayCanvas Entry point for PlayCanvas integration with 8th Wall Web.
Threejs Provides a camera pipeline module that drives three.js camera to do virtual overlays.
XrConfig Specifying class of devices and cameras that pipeline modules should run on.
XrController XrController provides 6DoF camera tracking and interfaces for configuring tracking.
XrDevice Provides information about device compatibility and characteristics.
XrPermissions Utilities for specifying permissions required by a pipeline module.