其他函数
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，则将自动根据纹理的原始尺寸确定尺寸。
|