CloudSpatialAnchorSession CloudSpatialAnchorSession CloudSpatialAnchorSession CloudSpatialAnchorSession Class

Definition

Use this class to create, locate and manage spatial anchors.

public ref class CloudSpatialAnchorSession : IDisposable
public class CloudSpatialAnchorSession : IDisposable
type CloudSpatialAnchorSession = class
    interface IDisposable
Public Class CloudSpatialAnchorSession
Implements IDisposable
Inheritance
CloudSpatialAnchorSessionCloudSpatialAnchorSessionCloudSpatialAnchorSessionCloudSpatialAnchorSession
Implements

Constructors

CloudSpatialAnchorSession() CloudSpatialAnchorSession() CloudSpatialAnchorSession() CloudSpatialAnchorSession()

Initializes a new instance with a default configuration.

Properties

Configuration Configuration Configuration Configuration

The configuration information for the session.

Diagnostics Diagnostics Diagnostics Diagnostics

The diagnostics settings for the session, which can be used to collect and submit data for troubleshooting and improvements.

LogLevel LogLevel LogLevel LogLevel

Logging level for the session log events.

Session Session Session Session

The tracking session used to help locate anchors.

SessionId SessionId SessionId SessionId

The unique identifier for the session.

Methods

CreateAnchorAsync(CloudSpatialAnchor) CreateAnchorAsync(CloudSpatialAnchor) CreateAnchorAsync(CloudSpatialAnchor) CreateAnchorAsync(CloudSpatialAnchor)

Creates a new persisted spatial anchor from the specified local anchor and string properties.

CreateWatcher(AnchorLocateCriteria) CreateWatcher(AnchorLocateCriteria) CreateWatcher(AnchorLocateCriteria) CreateWatcher(AnchorLocateCriteria)

Creates a new object that watches for anchors that meet the specified criteria.

DeleteAnchorAsync(CloudSpatialAnchor) DeleteAnchorAsync(CloudSpatialAnchor) DeleteAnchorAsync(CloudSpatialAnchor) DeleteAnchorAsync(CloudSpatialAnchor)

Deletes a persisted spatial anchor.

Dispose() Dispose() Dispose() Dispose()

Stops this session and releases all associated resources.

Finalize() Finalize() Finalize() Finalize()
GetAccessTokenWithAccountKeyAsync(String) GetAccessTokenWithAccountKeyAsync(String) GetAccessTokenWithAccountKeyAsync(String) GetAccessTokenWithAccountKeyAsync(String)

Gets the Azure Spatial Anchors access token from account key.

GetAccessTokenWithAuthenticationTokenAsync(String) GetAccessTokenWithAuthenticationTokenAsync(String) GetAccessTokenWithAuthenticationTokenAsync(String) GetAccessTokenWithAuthenticationTokenAsync(String)

Gets the Azure Spatial Anchors access token from authentication token.

GetActiveWatchers() GetActiveWatchers() GetActiveWatchers() GetActiveWatchers()

Gets a list of active watchers.

GetAnchorPropertiesAsync(String) GetAnchorPropertiesAsync(String) GetAnchorPropertiesAsync(String) GetAnchorPropertiesAsync(String)

Gets a cloud spatial anchor for the given identifier, even if it hasn't been located yet.

GetSessionStatusAsync() GetSessionStatusAsync() GetSessionStatusAsync() GetSessionStatusAsync()

Gets an object describing the status of the session.

ProcessFrame(IntPtr) ProcessFrame(IntPtr) ProcessFrame(IntPtr) ProcessFrame(IntPtr)

Applications must call this method on platforms where per-frame processing is required.

RefreshAnchorPropertiesAsync(CloudSpatialAnchor) RefreshAnchorPropertiesAsync(CloudSpatialAnchor) RefreshAnchorPropertiesAsync(CloudSpatialAnchor) RefreshAnchorPropertiesAsync(CloudSpatialAnchor)

Refreshes properties for the specified spatial anchor.

Reset() Reset() Reset() Reset()

Resets environment data that has been captured in this session; applications must call this method when tracking is lost.

Start() Start() Start() Start()

Begins capturing environment data for the session.

Stop() Stop() Stop() Stop()

Stops capturing environment data for the session and cancels any outstanding locate operations. Environment data is maintained.

UpdateAnchorPropertiesAsync(CloudSpatialAnchor) UpdateAnchorPropertiesAsync(CloudSpatialAnchor) UpdateAnchorPropertiesAsync(CloudSpatialAnchor) UpdateAnchorPropertiesAsync(CloudSpatialAnchor)

Updates the specified spatial anchor.

Events

AnchorLocated AnchorLocated AnchorLocated AnchorLocated
Error Error Error Error
LocateAnchorsCompleted LocateAnchorsCompleted LocateAnchorsCompleted LocateAnchorsCompleted
OnLogDebug OnLogDebug OnLogDebug OnLogDebug
SessionUpdated SessionUpdated SessionUpdated SessionUpdated
TokenRequired TokenRequired TokenRequired TokenRequired

Applies to