XR session subsystem
A "session" refers to an instance of AR. While the other AR subsystems provide specific pieces of functionality, like plane detection, the session controls the lifecycle of all AR-related subsystems. If you Stop
(or fail to Create
) an XRSessionSubsystem
, the other AR subsystems might not work.
Start
starts the session. Stop
pauses it.
Determining availability
Some platforms have AR capabilities built into the device's operating system. On others, AR software might be able to be installed on-demand. The question "is AR available on this device?" might require checking a remote server for software availability. Therefore, XRSessionSubsystem.GetAvailabilityAsync
should be called to determine whether AR is presently available to the app. This method returns a Promise<SessionAvailability>
, which can be used in a coroutine.
Once availability is determined, the device can be:
- unsupported.
- supported but requiring an update or install.
- supported and ready.
Installing additional AR software
If SessionAvailability
is SessionAvailability.Supported
but not SessionAvailability.Installed
, you should call InstallAsync
to install the AR software. This returns another type of Promise
: Promise<SessionInstallationStatus>
. If the installation is successful, it's safe to Start
the subsystem.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.