CloudSpatialAnchorSession Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Use this class to create, locate and manage spatial anchors.
public ref class CloudSpatialAnchorSession : IDisposablepublic class CloudSpatialAnchorSession : IDisposabletype CloudSpatialAnchorSession = class
interface IDisposablePublic Class CloudSpatialAnchorSession
Implements IDisposable- Inheritance
-
CloudSpatialAnchorSession
- Implements
Constructors
| CloudSpatialAnchorSession() |
Initializes a new instance with a default configuration. |
| CloudSpatialAnchorSession(IntPtr, Boolean) | |
Properties
| Configuration |
The configuration information for the session. |
| Diagnostics |
The diagnostics settings for the session, which can be used to collect and submit data for troubleshooting and improvements. |
| LocationProvider |
Location provider used to create and locate anchors using Coarse Relocalization. |
| LogLevel |
Logging level for the session log events. |
| Session |
The tracking session used to help locate anchors. |
| SessionId |
The unique identifier for the session. |
| TelemetryEnabled | |
Methods
| ConvertCookieToHandle(UInt64) | |
| ConvertHandleToCookie(IntPtr) | |
| CreateAnchorAsync(CloudSpatialAnchor) |
Creates a new persisted spatial anchor from the specified local anchor and string properties. |
| CreateWatcher(AnchorLocateCriteria) |
Creates a new object that watches for anchors that meet the specified criteria. |
| DeleteAnchorAsync(CloudSpatialAnchor) |
Deletes a persisted spatial anchor. |
| Dispose() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Finalize() |
Finalizes an instance of the CloudSpatialAnchorSession class. |
| GetAccessTokenWithAccountKeyAsync(String) |
Gets the Azure Spatial Anchors access token from account key. |
| GetAccessTokenWithAuthenticationTokenAsync(String) |
Gets the Azure Spatial Anchors access token from authentication token. |
| GetActiveWatchers() |
Gets a list of active watchers. |
| GetAnchorPropertiesAsync(String) |
Gets a cloud spatial anchor for the given identifier, even if it hasn't been located yet. |
| GetNearbyAnchorIdsAsync(NearDeviceCriteria) |
Gets a list of all nearby cloud spatial anchor ids corresponding to a given criteria. |
| GetSessionStatusAsync() |
Gets an object describing the status of the session. |
| ProcessFrame(IntPtr) |
Applications must call this method on platforms where per-frame processing is required. |
| RefreshAnchorPropertiesAsync(CloudSpatialAnchor) |
Refreshes properties for the specified spatial anchor. |
| Reset() |
Resets environment data that has been captured in this session; applications must call this method when tracking is lost. |
| Start() |
Begins capturing environment data for the session. |
| Stop() |
Stops capturing environment data for the session and cancels any outstanding locate operations. Environment data is maintained. |
| UpdateAnchorPropertiesAsync(CloudSpatialAnchor) |
Updates the specified spatial anchor. |
Events
| AnchorLocated | |
| Error | |
| LocateAnchorsCompleted | |
| OnLogDebug | |
| SessionUpdated | |
| TokenRequired | |
| UpdatedSensorFingerprintRequired |