其他函數
takeScreenshot
擷取目前相機檢視的螢幕截圖，可以選擇是否包含虛擬 (擴增) 內容。
|
名稱
|
類型
|
描述
|
必要/選用
|
預設
|
|---|---|---|---|---|
|
params
|
物件
|
物件包含了螢幕截圖組態。
|
必要
|
|
|
params.withAugmentation
|
布林
|
啟用或停用在螢幕截圖中加入虛擬或擴增內容的功能。
|
必要
|
|
|
params.dataURL
|
布林
|
啟用或停用在結果字串中加入資料 URI 前綴的功能 (例如 “data:image/png;base64,”)。
|
選用
|
true
|
|
params.imgFormat
|
字串
|
圖像格式。支援的檔案類型如下：
• .png
• .jpeg
|
選用
|
"PNG"
|
|
params.imgWidth
|
編號
|
擷取圖像的目標寬度 (以像素為單位)。
|
選用
|
|
|
params.imgHeight
|
編號
|
擷取圖像的目標高度 (以像素為單位)。
|
選用
|
|
|
successCallback
|
函數
|
在作業成功完成時呼叫。
|
選用
|
|
|
errorCallback
|
函數
|
在作業失敗時呼叫。
|
選用
|
 |
• 如未提供 imgWidth 或 imgHeight：
◦ 圖像是以相機的原始解析度進行擷取。
◦ 如果解析度低於螢幕寬度和高度的一半，圖像會至少放大至一半的螢幕寬度乘以一半的螢幕高度，以避免在體驗預覽中出現灰色邊框。
◦ 如果原始解析度已符合此臨界值，圖像則維持不變。
• 如果僅提供一個尺寸 (imgWidth 或 imgHeight)，則會自動計算缺少的尺寸，以維持原始的寬高比例。
• 如果同時提供兩個尺寸 (imgWidth 和 imgHeight)：
◦ 其中一個尺寸會重新計算，以保有原始的寬高比例。
◦ 最終圖像會符合界定的範圍內。
• 如果 dataURL 為 true，則 base64 編碼字串會以 MIME 類型作為前綴 (例如 "data:image/png;base64," 或 "data:image/jpeg;base64,")
• 圖像會透過 successCallback 傳回。
|
scanForNextBarCode
啟動條碼掃描器，然後靜候下一個可讀取的條碼。一旦偵測到條碼，掃描器就會停止掃描並回傳結果。
|
名稱
|
類型
|
描述
|
必要/選用
|
|---|---|---|---|
|
successCallback
|
函數
|
在作業成功完成時呼叫。
|
選用
|
|
errorCallback
|
函數
|
在作業失敗時呼叫。
|
選用
|
|
|
• 一旦偵測到有效的條碼，掃描就會自動停止。
• successCallback 中的回傳值是代表條碼的解碼字串。
|
scanBarCodeScanning
如果目前執行中條碼掃描器處於作用狀態，會停止執行；如果掃描器未執行，則不會產生影響。
|
名稱
|
類型
|
描述
|
必要/選用
|
|---|---|---|---|
|
successCallback
|
函數
|
在作業成功完成時呼叫。
|
選用
|
|
errorCallback
|
函數
|
在作業失敗時呼叫。
|
選用
|
|
|
• 此函數可用以手動取消透過 scanForNextBarcode 啟動的持續條碼掃描。
• 如果目前並未執行掃描，函數會成功回傳，但不會有任何影響。
• 掃描器也會在成功偵測到條碼後自動停止，因此往往只有在手動取消時才需要使用。
|
setupTrackingEventsCommand
註冊反呼叫以接收追蹤事件更新，例如追蹤目標的方位或定向變更。
|
名稱
|
類型
|
描述
|
必要/選用
|
|---|---|---|---|
|
successCallback
|
函數
|
在作業成功完成時呼叫。
|
選用
|
|
errorCallback
|
函數
|
在作業失敗時呼叫。
|
選用
|
|
|
• successCallback 會在執行追蹤時於每個畫面呼叫一次。
• 每次反呼叫都會接收一個包含下列值的字串陣列：
◦ trackerId - 目前追蹤器的 ID (即為追蹤器 ID)。
◦ cameraPosition - 相機在追蹤器空間中的方位，且以 [x,y,z] 格式的字串呈現。
◦ cameraForward - 追蹤器空間中相機的前進方向向量。
◦ cameraUp - 追蹤器空間中相機的向上方向向量。
◦ timestamp - 追蹤時的 UNIX 時間戳記 (以秒為單位)。
• 此函數目前不使用 errorCallback。
|
setDimensions
設定 3D 圖像的寬度與高度。
|
名稱
|
類型
|
描述
|
必要/選用
|
|
|---|---|---|---|---|
|
id
|
字串
|
要更新之 3D 圖像的 Studio ID。
|
必要
|
|
|
params
|
物件
|
物件包含了尺寸值。
|
必要
|
|
|
params.width
|
編號
|
圖像的目標寬度。
|
選用
|
NaN
|
|
params.height
|
編號
|
圖像的目標高度。
|
選用
|
NaN
|
|
successCallback
|
函數
|
在作業成功完成時呼叫。
|
選用
|
|
|
errorCallback
|
函數
|
在作業失敗時呼叫。
|
選用
|
|
|
• 此函數僅支援接受圖像的 3D 小工具 (3D 圖像、3D 量測計及 3D 標籤)。
• 如果省略寬度或高度或設為 NaN，欠缺的值會根據其他提供的尺寸計算，同時保有原始寬高比。
• 如果省略寬度和高度或設為 NaN，則會根據材質的原始大小自動判斷尺寸。
|