Fonctions diverses
takeScreenshot
Effectue une capture d'écran de la vue actuelle de la caméra, incluant éventuellement du contenu virtuel (augmenté).
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
Par défaut
|
|---|---|---|---|---|
|
params
|
Objet
|
Objet contenant la configuration de la capture d'écran.
|
Obligatoire
|
|
|
params.withAugmentation
|
Booléen
|
Active ou désactive l'inclusion de contenu virtuel ou augmenté dans la capture d'écran.
|
Obligatoire
|
|
|
params.dataURL
|
Booléen
|
Active ou désactive l'ajout d'un préfixe d'URI de données (par exemple, “data:image/png;base64,”) à la chaîne de résultat.
|
Facultatif
|
true
|
|
params.imgFormat
|
Chaîne
|
Format d'image. Les types de fichier suivants sont pris en charge :
• .png
• .jpeg
|
Facultatif
|
"PNG"
|
|
params.imgWidth
|
Nombre
|
Largeur de cible (en pixels) de l'image capturée.
|
Facultatif
|
|
|
params.imgHeight
|
Nombre
|
Hauteur cible (en pixels) de l'image capturée.
|
Facultatif
|
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
 |
• Si imgWidth ou imgHeight ne sont pas renseignés :
◦ L'image est capturée avec la résolution native de la caméra.
◦ Si la résolution est inférieure à la moitié de la largeur et de la hauteur de l'écran, l'image est convertie à au moins la moitié de la largeur de l'écran multipliée par la moitié de la hauteur de l'écran afin d'éviter les bordures grises dans l'aperçu dans l'expérience.
◦ Si la résolution native atteint déjà ce seuil, l'image reste inchangée.
• Si une seule dimension est fournie (imgWidth ou imgHeight), la dimension manquante est automatiquement calculée pour conserver le rapport d'aspect d'origine.
• Si les deux dimensions sont fournies (imgWidth et imgHeight) :
◦ Une dimension est recalculée pour conserver le rapport d'aspect d'origine.
◦ L'image finale s'adapte aux limites indiquées.
• Si dataURL est true, la chaîne codée en base64 est précédée d'un type MIME (par exemple, "data:image/png;base64," ou "data:image/jpeg;base64,").
• L'image est renvoyée via successCallback.
|
scanForNextBarCode
Démarre le lecteur de codes-barres et attend le prochain code-barres lisible. Une fois qu'un code-barres est détecté, le lecteur s'arrête et renvoie le résultat.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• Une fois qu'un code-barres valide est détecté, le scan s'arrête automatiquement.
• La valeur renvoyée dans successCallback est la représentation sous forme de chaîne décodée du code-barres.
|
scanBarCodeScanning
Arrête le lecteur de codes-barres en cours d'exécution s'il est actif et n'a aucun effet s'il n'est pas en cours d'exécution.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• Cette fonction peut être utilisée pour annuler manuellement un scan de code-barres en cours démarré via scanForNextBarcode.
• Si aucun scan n'est actuellement actif, la fonction renvoie un succès sans effet.
• Le lecteur s'arrête également automatiquement après une détection réussie du code-barres, de sorte que cela n'est généralement nécessaire que pour l'annulation manuelle.
|
setupTrackingEventsCommand
Enregistre un rappel pour recevoir des mises à jour d'événements de suivi, telles que les changements de position ou d'orientation d'une cible suivie.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• La fonction successCallback est appelée une fois par séquence pendant que le suivi est actif.
• Chaque rappel reçoit un tableau de chaînes avec les valeurs suivantes :
◦ trackerId : ID du suivi actuel (ID de suivi).
◦ cameraPosition : position de la caméra dans l'espace du suivi, sous la forme d'une chaîne au format [x,y,z].
◦ cameraForward : vecteur de direction vers l'avant de la caméra, dans l'espace du suivi.
◦ cameraUp : vecteur de direction vers le haut de la caméra, dans l'espace du suivi.
◦ timestamp : horodatage UNIX (en secondes) au moment du suivi.
• errorCallback n'est actuellement pas utilisé par cette fonction.
|
setDimensions
Définit la largeur et la hauteur d'une image 3D.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|
|---|---|---|---|---|
|
id
|
Chaîne
|
ID Studio de l'image 3D à mettre à jour.
|
Obligatoire
|
|
|
params
|
Objet
|
Objet contenant des valeurs de dimension.
|
Obligatoire
|
|
|
params.width
|
Nombre
|
Largeur de cible de l'image.
|
Facultatif
|
NaN
|
|
params.height
|
Nombre
|
Hauteur cible de l'image.
|
Facultatif
|
NaN
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• Cette fonction n'est prise en charge que pour les widgets 3D qui acceptent des images (Image 3D, Jauge 3D et Etiquette 3D).
• Si la largeur ou la hauteur est omise ou définie sur NaN, la valeur manquante sera calculée en fonction de l'autre dimension fournie tout en conservant le rapport d'aspect d'origine.
• Si la largeur et la hauteur sont omises ou définies sur NaN, les dimensions seront déterminées automatiquement à partir de la taille native de la texture.
|