Verschiedene Funktionen
takeScreenshot
Macht einen Screenshot der aktuellen Kameraansicht. Optional werden virtuelle Inhalte (AR-Inhalte) eingeschlossen.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
Standard
|
|---|---|---|---|---|
|
params
|
Objekt
|
Objekt, das die Screenshot-Konfiguration enthält
|
Erforderlich
|
|
|
params.withAugmentation
|
Boolesch
|
Aktiviert oder deaktiviert das Einschließen virtueller oder AR-Inhalte in den Screenshot
|
Erforderlich
|
|
|
params.dataURL
|
Boolesch
|
Aktiviert oder deaktiviert das Hinzufügen eines Daten-URI-Präfix (z.B “data:image/png;base64,”) zur Ergebniszeichenfolge
|
Optional
|
true
|
|
params.imgFormat
|
Zeichenfolge
|
Bildformat. Die folgenden Dateitypen werden unterstützt:
• .png
• .jpeg
|
Optional
|
"PNG"
|
|
params.imgWidth
|
Zahl
|
Zielbreite (in Pixeln) des aufgezeichneten Bilds
|
Optional
|
|
|
params.imgHeight
|
Zahl
|
Zielhöhe (in Pixeln) des aufgezeichneten Bilds
|
Optional
|
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
 |
• Sind imgWidth oder imgHeight nicht angegeben, so wird wie folgt vorgegangen:
◦ Das Bild wird mit der nativen Auflösung der Kamera aufgezeichnet.
◦ Ist die Auflösung kleiner als die Hälfte der Bildschirmbreite und -höhe, so wird das Bild auf mindestens die Hälfte der Bildschirmbreite Mal der Hälfte der Bildschirmhöhe hochskaliert, um graue Ränder in der Vorschau im Erlebnis zu vermeiden.
◦ Erreicht die native Auflösung bereits diesen Schwellenwert, so bleibt das Bild unverändert.
• Wird nur eine Bemaßung angegeben (imgWidth oder imgHeight), wird die fehlende Bemaßung automatisch berechnet, um das ursprüngliche Seitenverhältnis beizubehalten.
• Bei Bereitstellung beider Bemaßungen (imgWidth und imgHeight) wird wie folgt vorgegangen:
◦ Eine Bemaßung wird neu berechnet, um das ursprüngliche Seitenverhältnis beizubehalten.
◦ Das endgültige Bild passt in die vorgegebenen Grenzen.
• Ist dataURL gleich true, wird der base64-codierten Zeichenfolge ein MIME-Typ vorangestellt, z.B. "data:image/png;base64," oder "data:image/jpeg;base64,".
• Das Bild wird über successCallback zurückgegeben.
|
scanForNextBarCode
Startet den Barcode-Scanner und wartet auf den nächsten lesbaren Barcode. Sobald ein Barcode erkannt wird, stoppt der Scanner und gibt das Ergebnis zurück.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Sobald ein gültiger Barcode erkannt wird, wird der Scanvorgang automatisch gestoppt.
• Der zurückgegebene Wert in successCallback ist die dekodierte Zeichenfolgendarstellung des Barcodes.
|
scanBarCodeScanning
Beendet den derzeit ausgeführten Barcode-Scanner, sofern er aktiv ist. Dies hat keine Auswirkungen, wenn der Scanner nicht ausgeführt wird.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Mit dieser Funktion kann ein derzeit ausgeführter Barcode-Scan, der über scanForNextBarcode gestartet wurde, manuell abgebrochen werden.
• Ist derzeit kein Scan aktiv, so ist die Funktion erfolgreich, hat jedoch keine Auswirkungen.
• Der Scanner stoppt auch automatisch nach der erfolgreichen Erkennung eines Barcodes, so dass diese Funktion in der Regel nur für manuelles Abbrechen erforderlich ist.
|
setupTrackingEventsCommand
Registriert einen Callback, um Aktualisierungen von Verfolgungsereignissen zu erhalten, wie z.B. Änderungen der Position oder Orientierung eines verfolgten Ziels.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Der successCallback wird einmal pro Einzelbild aufgerufen, während die Verfolgung aktiv ist.
• Jeder Callback erhält ein Zeichenfolgen-Array mit den folgenden Werten:
◦ trackerId – ID des aktuellen Trackers (Tracker-ID)
◦ cameraPosition – Position der Kamera im Tracker-Raum als Zeichenfolge im Format [x,y,z]
◦ cameraForward – Vorwärtsrichtungsvektor der Kamera im Tracker-Raum
◦ cameraUp – Aufwärtsrichtungsvektor der Kamera im Tracker-Raum
◦ timestamp – UNIX-Zeitstempel (in Sekunden) zum Zeitpunkt der Verfolgung
• errorCallback wird derzeit von dieser Funktion nicht verwendet.
|
setDimensions
Legt die Breite und Höhe eines 3D-Bildes fest
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|
|---|---|---|---|---|
|
id
|
Zeichenfolge
|
Studio ID des zu aktualisierenden 3D-Bilds
|
Erforderlich
|
|
|
params
|
Objekt
|
Objekt, das Bemaßungswerte enthält
|
Erforderlich
|
|
|
params.width
|
Zahl
|
Zielbreite des Bilds
|
Optional
|
NaN
|
|
params.height
|
Zahl
|
Zielhöhe des Bilds
|
Optional
|
NaN
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Diese Funktion wird nur für 3D-Widgets unterstützt, die Bilder akzeptieren (3D-Bild, 3D-Anzeige und 3D-Beschriftung).
• Werden entweder Breite oder Höhe weggelassen oder auf NaNfestgelegt, so wird der fehlende Wert auf Grundlage der jeweils anderen bereitgestellten Bemaßungen unter Beibehaltung des ursprünglichen Seitenverhältnisses berechnet.
• Werden sowohl Breite als auch Höhe weggelassen oder auf NaNfestgelegt, so werden die Bemaßungen automatisch anhand der nativen Größe der Textur ermittelt.
|