Life-cycle Functions
initializeAR
Initializes the view that requires camera capabilities.
|
Name
|
Type
|
Description
|
Required/Optional
|
|---|---|---|---|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
errorCallBack
|
Function
|
Called when the operation fails.
|
Optional
|
 |
This function is automatically called by the experience at the start of an AR view or a 2D view that has a Camera or a Scan widget.
|
cleanUpAndPause
Cleans up the current view state when transitioning to another view.
|
Name
|
Type
|
Description
|
Required/Optional
|
|---|---|---|---|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|
|
|
This function is automatically called by the experience when navigating to a different view.
|
lockCameraAndOrientation
Freezes the current camera image so that the last rendered frame remains visible.
|
Name
|
Type
|
Description
|
Required/Optional
|
|---|---|---|---|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|
unlockCameraAndOrientation
Unfreezes the camera, allowing new frames to be rendered again.
|
Name
|
Type
|
Description
|
Required/Optional
|
|---|---|---|---|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|