CloudSpatialAnchorSession Classe

Paquet:

com.microsoft.azure.spatialanchors

• java.lang.Object
• • java.lang.AutoCloseable
  • • com.microsoft.azure.spatialanchors.CloudSpatialAnchorSession

public class CloudSpatialAnchorSession

Utilisez cette classe pour créer, localiser et gérer des ancres spatiales.

Récapitulatif du constructeur

Constructeur	Description
CloudSpatialAnchorSession()	Initialise une nouvelle instance avec une configuration par défaut.

Résumé de la méthode

Modificateur et type	Méthode et description
void	addAnchorLocatedListener(AnchorLocatedListener listener) Ajoute l’écouteur spécifié pour recevoir les événements AnchorLocated. Se produit lorsque l’emplacement d’une ancre est déterminé.
void	addErrorListener(SessionErrorListener listener) Ajoute l’écouteur spécifié pour recevoir les événements Error. Se produit lorsque la session ne peut pas poursuivre le traitement.
void	addLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener) Ajoute l’écouteur spécifié pour recevoir les événements LocateAnchorsCompleted. Se produit lorsque tous les résultats d’un observateur qui recherche des ancres sont traités.
void	addOnLogDebugListener(OnLogDebugListener listener) Ajoute l’écouteur spécifié pour recevoir les événements OnLogDebug. Se produit lorsqu’un message de journal de débogage est généré.
void	addSessionUpdatedListener(SessionUpdatedListener listener) Ajoute l’écouteur spécifié pour recevoir les événements SessionUpdated. Se produit lorsque tout l’état de session est mis à jour.
void	addTokenRequiredListener(TokenRequiredListener listener) Ajoute l’écouteur spécifié pour recevoir les événements TokenRequired. Se produit lorsque la session nécessite un jeton d’accès ou un jeton d’authentification mis à jour.
void	addUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener) Ajoute l’écouteur spécifié pour recevoir les événements UpdatedSensorFingerprintRequired. Se produit lorsque la session demande à l’application une empreinte digitale de capteur mise à jour.
void	close() Ferme cette ressource.
Future	createAnchorAsync(final CloudSpatialAnchor anchor) Crée une ancre spatiale persistante à partir des propriétés d’ancre et de chaîne locales spécifiées. L’ancre locale passée dans cette méthode doit avoir une transformation valide. Notez que certaines plateformes prises en charge par Azure Spatial Anchors, comme iOS, autorisent les transformations avec le composant d’échelle != 1.0. Le Kit de développement logiciel (SDK) Azure Spatial Anchors ne prend pas en charge ces transformations et ne parvient pas à créer l’ancre spatiale avec le code d’erreur InvalidAnchorTransformRigidity. Toute gestion de la mise à l’échelle pour les ancres doit être effectuée au niveau de l’application.
CloudSpatialAnchorWatcher	createWatcher(AnchorLocateCriteria criteria) Crée un objet qui surveille les ancres qui répondent aux critères spécifiés.
Future	deleteAnchorAsync(final CloudSpatialAnchor anchor) Supprime une ancre spatiale persistante.
void	finalize() Appelé par le récupérateur de mémoire sur un objet lorsque le garbage collection détermine qu’il n’y a plus de références à l’objet.
Future<String>	getAccessTokenWithAccountKeyAsync(final String accountKey) Obtient le jeton d’accès Azure Spatial Anchors à partir de la clé de compte.
Future<String>	getAccessTokenWithAuthenticationTokenAsync(final String authenticationToken) Obtient le jeton d’accès Azure Spatial Anchors à partir du jeton d’authentification.
List<CloudSpatialAnchorWatcher>	getActiveWatchers() Obtient la liste des observateurs actifs.
Future<CloudSpatialAnchor>	getAnchorPropertiesAsync(final String identifier) Obtient une ancre spatiale cloud pour l’identificateur donné, même si elle n’a pas encore été localisée.
SessionConfiguration	getConfiguration() Obtient les informations de configuration de la session. Les paramètres de configuration prennent effet au démarrage de la session.
CloudSpatialAnchorSessionDiagnostics	getDiagnostics() Obtient les paramètres de diagnostic de la session, qui peuvent être utilisés pour collecter et envoyer des données à des fins de résolution des problèmes et d’améliorations.
PlatformLocationProvider	getLocationProvider() Fournisseur d’emplacement utilisé pour créer et localiser des ancres à l’aide de [relocalisation grossière](https://aka.ms/CoarseRelocalization).
SessionLogLevel	getLogLevel() Niveau de journalisation des événements du journal de session.
Future<List<String>>	getNearbyAnchorIdsAsync(final NearDeviceCriteria criteria) Obtient une liste de tous les ID d’ancre spatiale cloud à proximité correspondant à un critère donné.
Session	getSession() Obtient la session de suivi utilisée pour aider à localiser les ancres. Cette propriété n’est pas disponible sur la plateforme HoloLens.
String	getSessionId() Obtient l’identificateur unique de la session.
Future<SessionStatus>	getSessionStatusAsync() Obtient un objet décrivant l’état de la session.
boolean	getTelemetryEnabled()
void	processFrame(Frame frame) Les applications doivent appeler cette méthode sur les plateformes où le traitement par image est requis. Cette méthode n’est pas disponible sur la plateforme HoloLens.
Future	refreshAnchorPropertiesAsync(final CloudSpatialAnchor anchor) Actualise les propriétés de l’ancre spatiale spécifiée.
void	removeAnchorLocatedListener(AnchorLocatedListener listener) Supprime l’écouteur spécifié pour recevoir les événements AnchorLocated. Se produit lorsque l’emplacement d’une ancre est déterminé.
void	removeErrorListener(SessionErrorListener listener) Supprime l’écouteur spécifié pour recevoir les événements d’erreur. Se produit lorsque la session ne peut pas poursuivre le traitement.
void	removeLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener) Supprime l’écouteur spécifié pour recevoir les événements LocateAnchorsCompleted. Se produit lorsque tous les résultats d’un observateur qui recherche des ancres sont traités.
void	removeOnLogDebugListener(OnLogDebugListener listener) Supprime l’écouteur spécifié pour recevoir les événements OnLogDebug. Se produit lorsqu’un message de journal de débogage est généré.
void	removeSessionUpdatedListener(SessionUpdatedListener listener) Supprime l’écouteur spécifié pour recevoir les événements SessionUpdated. Se produit lorsque tout l’état de session est mis à jour.
void	removeTokenRequiredListener(TokenRequiredListener listener) Supprime l’écouteur spécifié pour recevoir les événements TokenRequired. Se produit lorsque la session nécessite un jeton d’accès ou un jeton d’authentification mis à jour.
void	removeUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener) Supprime l’écouteur spécifié pour recevoir les événements UpdatedSensorFingerprintRequired. Se produit lorsque la session demande à l’application une empreinte digitale de capteur mise à jour.
void	reset() Réinitialise les données d’environnement qui ont été capturées dans cette session ; les applications doivent appeler cette méthode lorsque le suivi est perdu. Sur n’importe quelle plateforme, l’appel de la méthode nettoie tout l’état interne mis en cache.
void	setLocationProvider(PlatformLocationProvider value) Fournisseur d’emplacement utilisé pour créer et localiser des ancres à l’aide de [relocalisation grossière](https://aka.ms/CoarseRelocalization).
void	setLogLevel(SessionLogLevel value) Niveau de journalisation pour les événements du journal de session.
void	setSession(Session value) Définit la session de suivi utilisée pour localiser les ancres. Cette propriété n’est pas disponible sur la plateforme HoloLens.
void	setTelemetryEnabled(boolean value)
void	start() Commence la capture des données d’environnement pour la session.
void	stop() Arrête la capture des données d’environnement pour la session et annule toutes les opérations de localisation en attente. Les données d’environnement sont conservées.
Future	updateAnchorPropertiesAsync(final CloudSpatialAnchor anchor) Mises à jour l’ancre spatiale spécifiée.

Détails du constructeur

CloudSpatialAnchorSession

public CloudSpatialAnchorSession()

Initialise une nouvelle instance avec une configuration par défaut.

Détails de la méthode

addAnchorLocatedListener

public void addAnchorLocatedListener(AnchorLocatedListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements AnchorLocated. Se produit lorsque l’emplacement d’une ancre est déterminé.

Parameters:

listener

addErrorListener

public void addErrorListener(SessionErrorListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements Error. Se produit lorsque la session ne peut pas poursuivre le traitement.

Parameters:

listener

addLocateAnchorsCompletedListener

public void addLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements LocateAnchorsCompleted. Se produit lorsque tous les résultats d’un observateur qui recherche des ancres sont traités.

Parameters:

listener

addOnLogDebugListener

public void addOnLogDebugListener(OnLogDebugListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements OnLogDebug. Se produit lorsqu’un message de journal de débogage est généré.

Parameters:

listener

addSessionUpdatedListener

public void addSessionUpdatedListener(SessionUpdatedListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements SessionUpdated. Se produit lorsque tout l’état de session est mis à jour.

Parameters:

listener

addTokenRequiredListener

public void addTokenRequiredListener(TokenRequiredListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements TokenRequired. Se produit lorsque la session nécessite un jeton d’accès ou un jeton d’authentification mis à jour.

Parameters:

listener

addUpdatedSensorFingerprintRequiredListener

public void addUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener)

Ajoute l’écouteur spécifié pour recevoir les événements UpdatedSensorFingerprintRequired. Se produit lorsque la session demande à l’application une empreinte digitale de capteur mise à jour.

Parameters:

listener

close

public void close()

Ferme cette ressource.

createAnchorAsync

public Future createAnchorAsync(final CloudSpatialAnchor anchor)

Crée une ancre spatiale persistante à partir des propriétés d’ancre et de chaîne locales spécifiées. L’ancre locale passée dans cette méthode doit avoir une transformation valide. Notez que certaines plateformes prises en charge par Azure Spatial Anchors, comme iOS, autorisent les transformations avec le composant d’échelle != 1.0. Le Kit de développement logiciel (SDK) Azure Spatial Anchors ne prend pas en charge ces transformations et ne parvient pas à créer l’ancre spatiale avec le code d’erreur InvalidAnchorTransformRigidity. Toute gestion de la mise à l’échelle pour les ancres doit être effectuée au niveau de l’application.

Parameters:

anchor - Ancre à conserver.

createWatcher

public CloudSpatialAnchorWatcher createWatcher(AnchorLocateCriteria criteria)

Crée un objet qui surveille les ancres qui répondent aux critères spécifiés.

Parameters:

criteria - Critères pour les ancres à surveiller.

deleteAnchorAsync

public Future deleteAnchorAsync(final CloudSpatialAnchor anchor)

Supprime une ancre spatiale persistante.

Parameters:

anchor - Ancre à supprimer.

finalize

protected void finalize()

Appelé par le récupérateur de mémoire sur un objet lorsque le garbage collection détermine qu’il n’y a plus de références à l’objet.

getAccessTokenWithAccountKeyAsync

public Future getAccessTokenWithAccountKeyAsync(final String accountKey)

Obtient le jeton d’accès Azure Spatial Anchors à partir de la clé de compte.

Parameters:

accountKey - Clé de compte.

getAccessTokenWithAuthenticationTokenAsync

public Future getAccessTokenWithAuthenticationTokenAsync(final String authenticationToken)

Obtient le jeton d’accès Azure Spatial Anchors à partir du jeton d’authentification.

Parameters:

authenticationToken - Jeton d’authentification.

getActiveWatchers

public List getActiveWatchers()

Obtient la liste des observateurs actifs.

getAnchorPropertiesAsync

public Future getAnchorPropertiesAsync(final String identifier)

Obtient une ancre spatiale cloud pour l’identificateur donné, même si elle n’a pas encore été localisée.

Parameters:

identifier - Identificateur à rechercher.

getConfiguration

public SessionConfiguration getConfiguration()

Obtient les informations de configuration de la session. Les paramètres de configuration prennent effet au démarrage de la session.

getDiagnostics

public CloudSpatialAnchorSessionDiagnostics getDiagnostics()

Obtient les paramètres de diagnostic de la session, qui peuvent être utilisés pour collecter et envoyer des données à des fins de résolution des problèmes et d’améliorations.

getLocationProvider

public PlatformLocationProvider getLocationProvider()

Fournisseur d’emplacement utilisé pour créer et localiser des ancres à l’aide de [relocalisation grossière](https://aka.ms/CoarseRelocalization).

getLogLevel

public SessionLogLevel getLogLevel()

Niveau de journalisation des événements du journal de session.

getNearbyAnchorIdsAsync

public Future> getNearbyAnchorIdsAsync(final NearDeviceCriteria criteria)

Obtient une liste de tous les ID d’ancre spatiale cloud à proximité correspondant à un critère donné.

Parameters:

criteria - Les critères de recherche.

getSession

public Session getSession()

Obtient la session de suivi utilisée pour aider à localiser les ancres. Cette propriété n’est pas disponible sur la plateforme HoloLens.

getSessionId

public String getSessionId()

Obtient l’identificateur unique de la session.

getSessionStatusAsync

public Future getSessionStatusAsync()

Obtient un objet décrivant l’état de la session.

getTelemetryEnabled

public boolean getTelemetryEnabled()

processFrame

public void processFrame(Frame frame)

Les applications doivent appeler cette méthode sur les plateformes où le traitement par image est requis. Cette méthode n’est pas disponible sur la plateforme HoloLens.

Parameters:

frame - Trame AR à traiter.

refreshAnchorPropertiesAsync

public Future refreshAnchorPropertiesAsync(final CloudSpatialAnchor anchor)

Actualise les propriétés de l’ancre spatiale spécifiée.

Parameters:

anchor - Ancre à actualiser.

removeAnchorLocatedListener

public void removeAnchorLocatedListener(AnchorLocatedListener listener)

Supprime l’écouteur spécifié pour recevoir les événements AnchorLocated. Se produit lorsque l’emplacement d’une ancre est déterminé.

Parameters:

listener

removeErrorListener

public void removeErrorListener(SessionErrorListener listener)

Supprime l’écouteur spécifié pour recevoir les événements d’erreur. Se produit lorsque la session ne peut pas poursuivre le traitement.

Parameters:

listener

removeLocateAnchorsCompletedListener

public void removeLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener)

Supprime l’écouteur spécifié pour recevoir les événements LocateAnchorsCompleted. Se produit lorsque tous les résultats d’un observateur qui recherche des ancres sont traités.

Parameters:

listener

removeOnLogDebugListener

public void removeOnLogDebugListener(OnLogDebugListener listener)

Supprime l’écouteur spécifié pour recevoir les événements OnLogDebug. Se produit lorsqu’un message de journal de débogage est généré.

Parameters:

listener

removeSessionUpdatedListener

public void removeSessionUpdatedListener(SessionUpdatedListener listener)

Supprime l’écouteur spécifié pour recevoir les événements SessionUpdated. Se produit lorsque tout l’état de session est mis à jour.

Parameters:

listener

removeTokenRequiredListener

public void removeTokenRequiredListener(TokenRequiredListener listener)

Supprime l’écouteur spécifié pour recevoir les événements TokenRequired. Se produit lorsque la session nécessite un jeton d’accès ou un jeton d’authentification mis à jour.

Parameters:

listener

removeUpdatedSensorFingerprintRequiredListener

public void removeUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener)

Supprime l’écouteur spécifié pour recevoir les événements UpdatedSensorFingerprintRequired. Se produit lorsque la session demande à l’application une empreinte digitale de capteur mise à jour.

Parameters:

listener

reset

public void reset()

Réinitialise les données d’environnement qui ont été capturées dans cette session ; les applications doivent appeler cette méthode lorsque le suivi est perdu. Sur n’importe quelle plateforme, l’appel de la méthode nettoie tout l’état interne mis en cache.

setLocationProvider

public void setLocationProvider(PlatformLocationProvider value)

Fournisseur d’emplacement utilisé pour créer et localiser des ancres à l’aide de [relocalisation grossière](https://aka.ms/CoarseRelocalization).

Parameters:

value - Nouvelle valeur.

setLogLevel

public void setLogLevel(SessionLogLevel value)

Niveau de journalisation pour les événements du journal de session.

Parameters:

value - Nouvelle valeur.

setSession

public void setSession(Session value)

Définit la session de suivi utilisée pour localiser les ancres. Cette propriété n’est pas disponible sur la plateforme HoloLens.

Parameters:

value - Nouvelle valeur.

setTelemetryEnabled

public void setTelemetryEnabled(boolean value)

Parameters:

value

start

public void start()

Commence la capture des données d’environnement pour la session.

stop

public void stop()

Arrête la capture des données d’environnement pour la session et annule toutes les opérations de localisation en attente. Les données d’environnement sont conservées.

updateAnchorPropertiesAsync

public Future updateAnchorPropertiesAsync(final CloudSpatialAnchor anchor)

Mises à jour l’ancre spatiale spécifiée.

Parameters:

anchor - Ancre à mettre à jour.