Session

Actions

Add Runtime Candidate Image

Create an ARCandidateImage object and add it to the ARCandidateImageList of the given \c UARSessionConfig object.

Note that you need to restart the AR session with the \c UARSessionConfig you are adding to to make the change take effect.

On ARCore platform, you can leave the PhysicalWidth to 0 if you don't know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.

Target is ARBlueprint Library

Add Runtime Candidate Image from Rawbytes

Create an ARCandidateImage object from the raw pixel data and add it to the ARCandidateImageList of the given \c UARSessionConfig object.

Note that you need to restart the AR session with the \c UARSessionConfig you are adding to to make the change take effect.

On ARCore platform, you can leave the PhysicalWidth and PhysicalHeight to 0 if you don't know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.

Target is Google ARCore Session Function Library

Get AR Session Config

Target is ARBlueprint Library

Get AR Session Status

It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly. e.g. if the session stopped for an unexpected reason, you might give the user a prompt to re-start the session

Target is ARBlueprint Library

Pause AR Session

Pause a running Augmented Reality session without clearing existing state.

Target is ARBlueprint Library

Start AR Session

Begin a new Augmented Reality session. Subsequently, use the \c GetARSessionStatus() function to figure out the status of the session.

Target is ARBlueprint Library

Stop AR Session

Stop a running Augmented Reality session and clear any state.

Target is ARBlueprint Library