检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API列表 调用前须知 视觉定位 空间位置追踪与渲染 导航 事件管理 SDK内部派发事件 父主题: WebARSDK使用手册
API列表 调用前准备工作 视觉定位 事件 日志 其他 父主题: XRLightSDK使用手册
注意事项 视频流无法正常获取原因排查 如果您无法获取视频流,建议您排查以下问题: 检查是否存在浏览器多个标签页同时申请获取视频流的情况,建议您关闭其他标签页。 检查浏览器是否支持WebRTC,如不支持,建议您更换浏览器。 检查应用相机权限是否打开。 检查移动设备后置摄像头是否能正常拍摄画面。
注意事项 如果您无法获取视频流,建议排查以下问题: 检查小程序相机权限是否打开。 检查移动设备后置摄像头是否能正常拍摄画面。 父主题: 开启AR会话
状态码 常用状态码请参见表1。 表1 请求状态返回码 状态码 描述 说明 200 OK 服务器已成功处理了请求。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,
事件管理 事件管理使用到的接口如表1所示。 表1 事件管理接口列表 接口 描述 参数名 参数类型 参数说明 返回值 dispatchEvent 事件派发。 strId string 侦听事件id。 void data { [key: string]: DataType } 携带的数据。
定位失败,定位结果显示“invalid url” 检查初始化视觉定位模块config参数中配置的url是否正确。url为https://koomap.cn-north-4.myhuaweicloud.com。 父主题: 常见问题
事件 接口列表 表1 事件接口列表 接口 描述 参数名 参数类型 参数说明 返回值 addEvent 侦听事件。 evtName string 事件ID。 根据实际情况选择Vps定位结果事件ID、Vps状态事件ID或scene实例事件ID。 void cb Function 侦听到事件后,触发的回调函数。
定位失败,定位结果显示“OutOfService” 登录KooMap管理控制台,检查是否开通了AR地图运行服务,如未开启,请开通AR地图运行服务。 父主题: 常见问题
定位失败,定位结果显示“Incorrect IAM” 检查初始化视觉定位模块config参数中配置的AK、SK是否正确。获取方法请参见访问密钥。 父主题: 常见问题
SDK内部派发事件 SDK内部派发事件如表1所示。 表1 SDK内部派发事件列表 事件名称 描述 携带的数据 数据类型 事件说明 GYRO_STATUS 陀螺仪有效性检测。 gyro boolean 需要侦听回调,回调函数会接收到一个参数:event: { data: Object
视觉定位 接口列表 视觉定位需要使用的接口如表1所示。 表1 视觉定位接口列表 接口 描述 参数名 参数类型 参数说明 返回值 getToken 向服务器请求签名。 - - - Promise<any> setAKSK 验证租户身份信息。 requestParams { AK: string;
视觉定位 接口列表 表1 视觉定位接口列表 接口 描述 参数名 参数类型 参数说明 返回值 init 初始化视觉定位模块。 config { access: string, secret: string, beforeLocateDelta: number, afterLocateDelta:
日志 接口列表 表1 日志接口列表 接口 描述 参数名 参数类型 参数说明 返回值 initLogger 初始化日志模块 logger ILog 日志的实例 void setIsSaveLog 日志存储 isSave boolean 是否存储日志 void setLogOutputLevel
调用前准备工作 XRLightSDK封装类名为“XRClient”,所有API均直接通过类“XRClient”来调用,无需实例化。 在调用SDK前,需在文件头部引入XRClient类。 import { XRClient } from "../../SDK/XRClient"; 父主题:
空间位置追踪与渲染 接口列表 空间位置追踪与渲染需要使用到的接口如表1所示。 表1 空间位置追踪与渲染接口列表 接口 描述 参数名 参数类型 参数说明 返回值 createARSession 创建AR会话。 - - - Promise<void> setARStatus 设置AR状态。
调用前须知 调用API前,您需提前了解如下内容: WebARSDK封装类名为“hwar”,所有API均直接通过类“hwar”来调用,无需实例化。 下文API中的GPS坐标系为WGS84坐标系。 utmCode指UTM(Universal Transverse Mercator Grid
API概览 云地图服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 视觉定位 通过拍摄一系列具有已知位置的图像并分析它们的关键视觉特征(例如建筑物或桥梁的轮廓)来创建地图,以创建这些视觉特征的大规模且可快速搜索的索引。将设备图像中的特征与索引中的特征进行比较,可获得目标设备的位姿。
其他 接口列表 表1 其他接口列表 接口 描述 参数名 参数类型 参数说明 返回值 requestNavi 请求导航路径。 utmCode string 当前utm区域。 void from number[3] 导航出发点utm坐标。 to number[3] 导航目的地utm坐标。
导航 导航需要使用到的接口如表1所示。 表1 导航接口列表 接口 描述 参数名 参数类型 参数说明 返回值 searchPoi POI智能搜索。 searchData { floor?: string; address?: string; title?: string; tag?: