その他の関数
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 が指定されていない場合、次のようになります。
◦ イメージはカメラのネイティブ解像度でキャプチャされます。
◦ 解像度がスクリーンの幅と高さの半分よりも小さい場合、エクスペリエンス内プレビューでグレーの境界が表示されないように、イメージは、"スクリーンの幅の半分 x スクリーンの高さの半分" 以上のサイズに拡大されます。
◦ ネイティブ解像度がこのしきい値にすでに達している場合、イメージは変更されません。
• 寸法が 1 つだけ (imgWidth または imgHeight) 指定されている場合、元のアスペクト比を維持するように、欠落している寸法が自動的に計算されます。
• 両方の寸法 (imgWidth と imgHeight) が指定されている場合、次のようになります。
◦ 元のアスペクト比を維持するように、1 つの寸法が再計算されます。
◦ 最終的なイメージは、指定された範囲に収まります。
• 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 がフレームごとに 1 回呼び出されます。
• 各コールバックは、次の値を持つ文字列配列を受信します。
◦ 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 に設定されている場合、寸法はテクスチャのネイティブサイズから自動的に決定されます。
|