2022移动设备增强现实系统应用接口

移动设备增强现实系统应用接口目  次目  次 I前  言 III信息技术移动设备增强现实系统应用接口 1范围 1规范性引用文件 1术语和定义 1缩略语 2应用程序接口框架 2数据类型 3返回结果 3设备类型 4数据流模式 4节点类型 4算法类型 4算法模式 5可用性 5跟踪状态 5跟踪运行模式 5世界坐标对齐模式 6顶点格式 6像素格式 6参数 7左右眼视角 7光照估计模式 7光照估计状态 7求交查询模式 7云锚点状态 8平面类型 8手势类型 8左右手类型 9手掌心朝向 9应用程序接口 9功能地址 10能力检测 107.3 位姿 117.4 配置 11增强现实会话 15增强现实世界地图 21帧画面 22相机模型 27I相机内参 287.10 点云 29稠密重建 30光照计算 32锚点列表 337.14 锚点 337.15 节点列表 357.16 节点 35平面节点 37查询结果列表 39查询结果 39参考图数据库 41图像节点 42手势节点 43IIII1313信息技术移动设备增强现实系统应用接口范围本文件规定了移动设备增强现实系统开发的数据类型和应用程序接口。本文件适用于移动设备增强现实系统的设计、开发和应用。规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T38247-2019信息技术增强现实术语GB/TXXXXX-XXXX信息技术手持式移动设备增强现实系统技术规范术语和定义GB/T38247-2019和GB/TXXXXX-XXXX界定的以及下列术语和定义适合于本文件。3.1移动设备 mobiledevice具备摄像头、显示屏、网络功能以及可检测其方位和运动信息的元件的终端设备。注：包括具备六自由度定位功能的手机、平板电脑等手持式移动设备以及头盔显示器、AR眼镜等头戴式移动设备。3.2参考图像referenceimage在环境中可被识别的二维图像。[来源：GB/T38247-2019，2.2.18]3.3增强现实会话augmentedrealitysession负责管理增强现实系统的整个运行过程，包括创建、启动、更新、关闭、销毁等各个过程。3.4增强现实地图augmentedrealitymap增强现实运行过程中构建的地图结构，包括检测到的点云、平面节点、图像节点等信息，以及用户创建的锚点。3.5节点nodePAGEPAGE10PAGEPAGE3增强现实运行过程中识别出的平面、图像、手势等具体对象信息。3.6点云pointcloud在增强现实应用中，用于恢复三维场景而使用的场景物体表面的三维点数据集合。[来源：GB/T38247-2019，2.2.47]3.7稠密网格densemesh稠密三维重建过程中，恢复的场景三角形网格。缩略语下列缩略语适用于本文件。6DoF六自由度（SixDegreesofFreedom）AR 增强现实(AugmentedReality)API应用程序接口（ApplicationProgrammingInterface）FPS每秒帧数（FramesPerSecond）IMU惯性测量单元（InertialMeasurementUnit）SLAM同步定位与地图构建（SimultaneousLocalizationAndMapping）应用程序接口框架移动设备增强现实系统应用程序接口框架符合GB/TXXXXX-XXXX的规定。移动设备增强现实系统模块通过接口和结构来完成相关的功能。实时跟踪定位模块利用移动设备的输入数据计算出相机模型(ARCamera)和相机内参（ARCameraIntrinsics）；三维重建模块利用尺度估计模块计算的尺度信息和实时跟踪定位模块计算的6DoF位姿等信息，计算出平面节点（ARPlaneNode）、点云（ARPointCloud）（ARDenseMesh）ARIageodeARIlumnatonEtimt；如果移动设备具备云计算服务，还支持将数据通过网络传输到云服务端实现更高效率的云端重定位、云端标志物识别和云端三维重建，并将解算结果传输回移动设备处理单元。移动设备增强现实系统应用程序接口框架见图1。图1移动设备增强现实系统应用程序接口框架数据类型返回结果返回结果数据类型命名为ARResult，其值定义见表1。表1返回结果数据类型ARResult定义ARResult值描述ARRESULT_SUCCESS=0成功或者正确ARRESULT_ERROR_INVALID_ARGUMENT=-1包含无效参数ARRESULT_ERROR_FATAL=-2严重错误ARRESULT_ERROR_SESSION_PAUSED=-3当前操作ARSession暂停状态错误ARRESULT_ERROR_SESSION_NOT_PAUSED=-4当前操作ARSession未暂停状态错误ARRESULT_ERROR_NOT_TRACKING=-5目前不处于跟踪状态导致的错误ARRESULT_ERROR_TEXTURE_NOT_SET=-6未设置纹理参数导致的错误ARRESULT_ERROR_UNSUPPORTED_VIDEOFORMAT=-7指定的视频格式不支持错误ARRESULT_ERROR_CAMERA_NOT_AVAILABLE=-8摄像机服务不可用错误ARRESULT_ERROR_CAMERA_PERMISSION_NOT_GRANTED=-9摄像机服务未授权导致的错误ARRESULT_ERROR_UNSUPPORTED_CONFIG=-10设置的配置选项不支持导致的错误ARRESULT_ERROR_RESOURCE_EXHAUSTED=-11没有可用资源导致的错误ARRESULT_ERROR_CLOUD_ANCHORS_NOT_CONFIGURED=-12没有对云锚点模式进行设置导致的错误ARRESULT_ERROR_ANCHOR_NOT_SUPPORTED_FOR_HOSTING=-13该锚点不支持托管导致的错误ARRESULT_ERROR_DEVICE_UNSUPPORT=-14移动设备不支持增强现实导致的错误ARRESULT_ERROR_ALGORITHM_UNSUPPORT=-15使用不支持的算法导致的错误ARRESULT_ERROR_APPLICATION_AUTHORIZED=-16该应用未授权使用增强现实功能导致的错误设备类型设备类型数据类型命名为ARDeviceType,其值定义见表2。表2设备类型数据类型ARDeviceType定义ARDeviceType值描述ARDEVICE_TYPE_HANDHOLD=100手持式移动设备ARDEVICE_TYPE_HEADMOUNTED=200头戴式移动设备数据流模式数据流模式数据类型命名为ARStreamMode，其值定义见表3。表3数据流模式数据类型ARStreamMode定义ARStreamMode值描述ARSTREAM_MODE_FRONT_RGB=100数据流采用前置RGB相机模式ARSTREAM_MODE_BACK_RGB=2000数据流采用后置RGB相机模式ARSTREAM_MODE_BACK_RGBD=2100数据流采用后置RGBD相机模式ARSTREAM_MODE_BACK_STEREO=2200数据流采用后置立体相机模式节点类型节点类型数据类型命名为ARNodeType，其值定义见表4。表4节点类型数据类型ARNodeType定义ARNodeType值描述ARNODE_TYPE_UNKNOWN=-1无效节点类型ARNODE_TYPE_PLANE=1平面节点类型ARNODE_TYPE_IMAGE=2图像节点类型ARNODE_TYPE_HAND_GESTURE=3手势节点类型算法类型算法类型数据类型命名为ARAlgorithmType，其值定义见表5。表5算法类型数据类型ARAlgorithmType定义ARAlgorithmType值描述ARALGORITHM_TYPE_UNKNOWN=-1无效算法类型ARALGORITHM_TYPE_SLAM=1SLAM算法类型ARALGORITHM_TYPE_HAND_GESTURE=2手势算法类型ARALGORITHM_TYPE_DENSE_RECON=3稠密网格重建算法类型ARALGORITHM_TYPE_IMAGE_TRACKING=4图像跟踪算法类型ARALGORITHM_TYPE_PLANE_DETECTION=5平面检测算法类型ARALGORITHM_TYPE_ILLUMINATION_ESTIMATION=6光照估计算法类型ARALGORITHM_TYPE_CLOUD_ANCHOR=7云锚点算法类型算法模式算法模式数据类型命名为ARAlgorithmMode，其值定义见表6。表6算法模式数据类型ARAlgorithmMode定义ARAlgorithmMode值描述ARALGORITHM_MODE_DISABLE=0算法关闭模式ARALGORITHM_MODE_ENABLE=1算法激活模式可用性可用性数据类型命名为ARAvailability，其值定义见表7。表7可用性数据类型ARAvailability定义ARAvailability值描述ARAVAILABILITY_SUPPORTED=1设备支持，并且可用ARAVAILABILITY_UNKNOWN_ERROR=-1未知错误ARAVAILABILITY_UNSUPPORTED_DEVICE_NOT_CAPABLE=-100设备不支持ARARAVAILABILITY_SUPPORTED_NOT_INSTALLED=-201设备支持，模块未安装导致不可用ARAVAILABILITY_SUPPORTED_VERSION_TOO_OLD=-202设备支持，模块版本太旧导致不可用跟踪状态跟踪状态数据类型命名为ARTrackingState，其值定义见表8。表8跟踪状态数据类型ARTrackingState定义ARTrackingState值描述ARTRACKING_STATE_SUCCESS=0正常跟踪状态ARTRACKING_STATE_LOST=1跟踪丢失状态ARTRACKING_STATE_STOPPED=2停止跟踪状态ARTRACKING_STATE_INITIALIZING=10跟踪初始化中状态跟踪运行模式跟踪运行模式数据类型命名为ARTrackingRunMode，其值定义见表9。表9跟踪运行模式数据类型ARTrackingRunMode定义ARTrackingRunMode值描述ARTRACKING_RUN_MODE_AUTO=0自动跟踪模式，增强现实会话恢复运行后，算法自动启动运行ARTRACKING_RUN_MODE_MANUAL=1手动跟踪模式，增强现实会话恢复运行后，算法默认不启动，需要手动启动运行世界坐标对齐模式世界坐标对齐模式数据类型命名为ARWorldAlignmentMode，其值定义见表10。表10世界坐标对齐模式数据类型ARWorldAlignmentMode定义ARWorldAlignmentMode值描述ARWORLD_ALIGNMENT_MODE_GRAVITY0=0根据初始化时候屏幕的朝向和重力方向构建世界坐标系ARWORLD_ALIGNMENT_MODE_GRAVITY_HEADING=1根据指南针和重力方向构建世界坐标系，y指向所在位置的朝南方向顶点格式顶点格式数据类型命名为ARVertexFormat，其值定义见表11。表11顶点格式数据类型ARVertexFormat定义ARVertexFormat值描述ARVERTEX_FORMAT_UNKNOWN=-1无效顶点数据ARVERTEX_FORMAT_3D_POSITION=0顶点数据包含3个float值，表示该点坐标ARVERTEX_FORMAT_3D_POSITION_NORMAL=16float的平面法线向量ARVERTEX_FORMAT_3D_POSITION_NORMAL_COLOR=210float点的平面法线向量和该点的RGBA数据像素格式像素格式数据类型命名为ARPixelFormat，其值定义见表12。表12像素格式数据类型ARPixelFormat定义ARPixelFormat值描述ARPIXEL_FORMAT_UNKNOWN=-1无效图像数据ARPIXEL_FORMAT_LUMINANCE8=0图像数据采用LUMINANCE8格式ARPIXEL_FORMAT_RG16=1图像数据采用RG16格式ARPIXEL_FORMAT_RGB24=2图像数据采用RGB24格式ARPIXEL_FORMAT_RGBA32=3图像数据采用RGBA32格式ARPIXEL_FORMAT_DEPTH16=4图像数据采用Depth16格式ARPIXEL_FORMAT_YUV_NV21=1000图像数据采用YUVNV21格式参数参数数据类型命名为ARParameterEnum，其值定义见表13。表13参数数据类型ARParameterEnum定义ARParameterEnum值描述ARPARAMETER_VIDEO_VERTICAL_FOV=50视频垂直方向FOVARPARAMETER_ALGORITHM_SLAM_INFO=100SLAM算法运行信息ARPRARMETER_ALGORITHM_SLAM_MAP_QUALITY=101SLAM地图质量ARPARAMETER_ALGORITHM_SLAM_DETAIL_STATE=102SLAM算法内部详细的运行状态ARPARAMETER_CAMERA_TEXTURE_TARGET=3000视频流纹理ID左右眼视角左右眼视角数据类型命名为AREyeSide，其值定义见表14。表14左右眼视角数据类型AREyeSide定义AREyeSide值描述AREYE_LEFT=0左眼视角AREYE_RIGHT=1右眼视角光照估计模式光照估计模式数据类型命名为ARIlluminationEstimateMode，其值定义见表15。表15光照估计模式数据类型ARIlluminationEstimateMode定义ARIlluminationEstimateMode值描述ARILLUMINATION_ESTIMATE_MODE_AMBIENT_INTENSITY=1环境光亮度模式，包含单一亮度值光照估计状态光照估计状态数据类型命名为ARIlluminationEstimateState，其定义见表16。16ARIlluminationEstimateStateARIlluminationEstimateState值描述ARILLUMINATION_ESTIMATE_STATE_NOT_VALID=0光照估计结果暂时不可用ARILLUMINATION_ESTIMATE_STATE_VALID=1光照估计结果可用求交查询模式求交查询模式数据类型命名为ARQueryMode，其值定义见表17。表17求交查询模式数据类型ARQueryMode定义ARQueryMode值描述ARQUERY_MODE_POLYGON_ONLY=0只能跟多边形平面求交查询ARQUERY_MODE_POLYGON_AND_HORIZONPLANE=1能跟多边形平面以及水平多边形所在整个无限平面求交查询ARQUERY_MODE_POLYGON_PERSISTENCE=2能跟多边形平面以及多边形平面所在的无限平面求交查询，多边形平面优先云锚点状态云锚点状态数据类型命名为ARCloudAnchorState，其值定义见表18。表18云锚点状态数据类型ARCloudAnchorState定义ARCloudAnchorState值描述ARCLOUD_ANCHOR_STATE_NONE=0该锚点不是云锚点ARCLOUD_ANCHOR_STATE_TASK_IN_PROGRESS=1正在托管或是解析中ARCLOUD_ANCHOR_STATE_SUCCESS=2托管或解析成功ARCLOUD_ANCHOR_STATE_ERROR_INTERNAL=-1托管或解析发生内部错误ARCLOUD_ANCHOR_STATE_ERROR_NOT_AUTHORIZED=-2托管或解析没有被授权ARCLOUD_ANCHOR_STATE_ERROR_SERVICE_UNAVAILABLE=-3当前服务不可用ARCLOUD_ANCHOR_STATE_ERROR_RESOURCE_EXHAUSTED=-4资源已经被用尽ARCLOUD_ANCHOR_STATE_ERROR_HOSTING_DATASET_PROCESSING_FAILED=-5云锚点数据错误，不能托管ARCLOUD_ANCHOR_STATE_ERROR_CLOUD_ID_NOT_FOUND=-6该云锚点ID没有被找到ARCLOUD_ANCHOR_STATE_ERROR_RESOLVING_LOCALIZATION_NO_MATCH=-7解析失败，环境无法匹配ARCLOUD_ANCHOR_STATE_ERROR_RESOLVING_SDK_VERSION_TOO_OLD=-8解析锚点的SDK版本过旧ARCLOUD_ANCHOR_STATE_ERROR_RESOLVING_SDK_VERSION_TOO_NEW=-9解析锚点的SDK版本过新ARCLOUD_ANCHOR_STATE_ERROR_UNKNOWN=-11未知错误平面类型平面类型数据类型命名为ARPlaneType，其值定义见表19。表19平面类型数据类型ARPlaneType定义ARPlaneType值描述ARPLANE_TYPE_UNKNOWN=-1无效平面类型ARPLANE_TYPE_UPWARD_FACING=0水平朝上平面类型ARPLANE_TYPE_DOWNWARD_FACING=1水平朝下平面类型ARPLANE_TYPE_VERTICAL=2垂直平面类型手势类型手势类型数据类型命名为ARHandGestureType，其值定义见表20。表20手势类型数据类型ARHandGestureType定义ARHandGestureType值描述ARHAND_GESTURE_TYPE_UNKNOWN=-1无效手势类型ARHAND_GESTURE_TYPE_OK=0OK手势类型ARHAND_GESTURE_TYPE_SCISSORS=1剪刀手势类型ARHAND_GESTURE_TYPE_THUMBS_UP=2竖起大拇指手势类型ARHAND_GESTURE_TYPE_PAPER=3布手势类型ARHAND_GESTURE_TYPE_GUN=4手枪手势类型ARHAND_GESTURE_TYPE_ROCK=5石头手势类型ARHAND_GESTURE_TYPE_FINGER_HEART=6比心手势类型ARHAND_GESTURE_TYPE_FINGERTIP=7指尖手势类型ARHAND_GESTURE_TYPE_WELL_PLAYED=8做得好手势类型ARHAND_GESTURE_TYPE_THREE_FINGERS=93个手指手势类型ARHAND_GESTURE_TYPE_FOUR_FINGERS=104个手指手势类型ARHAND_GESTURE_TYPE_I_LOVE_YOU=11我爱你手势类型ARHAND_GESTURE_TYPE_INDEX_FINGER_AND_LITTLE_FINGER=12竖起食指与小拇指手势类型ARHAND_GESTURE_TYPE_LITTLE_FINGER=13小拇指手势类型左右手类型左右手类型数据类型命名为ARHandType，其值定义见表21。表21左右手类型数据类型ARHandType定义ARHandType值描述ARHAND_TYPE_UNKNOWN=-1无法区分左右手ARHAND_TYPE_RIGHT=0右手ARHAND_TYPE_LEFT=1左手手掌心朝向手掌心朝向数据类型命名为ARHandTowards，其值定义见表22。表22手掌心朝向数据类型ARHandTowards定义ARHandTowards值描述ARHAND_TOWARDS_UNKNOWN=-1无效的手朝向ARHAND_TOWARDS_PALM=0手心方向ARHAND_TOWARDS_THE_BACK_OF_HAND=1手背方向ARHAND_TOWARDS_SIDE_HAND=2侧手方向应用程序接口功能地址获取扩展函数地址接口定义：PFN_arVoidFunctionarGetProcAddress(constchar*name)功能描述：通过给定的字符串，获取功能扩展的函数指针。输入参数：类型：constchar*，值：函数指针的名字。输出参数：类型：PFN_arVoidFunction，值：typedefvoid(ARAPI_PTR*PFN_arVoidFunction)(void)，定义了函数指针的类型，ARAPI_PTR能力检测检测设备是否支持接口定义：voidarCapabilityCheckAvailability(void*env,void*context,ARAvailability*out_availability)功能描述：检测设备是否支持运行增强现实模块。输入参数：类型：void*，值：运行环境。类型：void*，值：运行上下文。输出参数：类型：ARAvailability*7检测是否支持算法接口定义：ARResultarCapabilityCheckAlgorithm(void*env,void*context,ARAlgorithmTypetype,ARStreamModemode)ARRESULT_SUCCESS输入参数：类型：void*，值：运行环境。类型：void*，值：运行上下文。类型：ARAlgorithmType5类型：ARStreamMode3输出参数：类型：ARResult1检测是否授权ARRsultarapailiyChckAthoize(vod*env,voi*conext,costcha*appId)ARRESULT_SUCCESS输入参数：类型：void*，值：运行环境。类型：void*，值：运行上下文。类型：constchar*，值：应用程序授权字符串。输出参数：x)类型：ARResult，值：返回值，见表1定义。位姿创建位姿接口定义：voidarPoseCreate(constfloat*pose_raw,ARPose**out_pose)6DF信息qx,q,qzqw,x,t,t。输入参数：类型：constfloat*，值：6DoF类型：ARPose**，值：创建新的位姿结构，结构地址保存到*out_pose中。释放位姿接口定义：voidarPoseDestroy(ARPose*pose)功能描述：销毁位姿结构。输入参数：类型：ARPose*，值：位姿结构指针。输出参数：不作定义。6DoF接口定义：voidarPoseGetPoseRaw(constARPose*pose,float*out_pose_raw)6DoF信息（q,qyqz,w,t,tytz7。输入参数：类型：constARPose*，值：位姿结构指针。输出参数：类型：float*，值：6DoF信息。获取位姿结构的矩阵接口定义：voidarPoseGetMatrix(constARPose*pose,float*out_matrix_col_major_4x4)功能描述：获取位姿结构对应的4×4矩阵。输入参数：类型：constARPose*，值：位姿结构指针。输出参数：类型：float*，值：矩阵，该矩阵为列矩阵形式。配置创建配置接口定义：voidarConfigCreate(ARConfig**out_config)功能描述：创建配置结构。输入参数：不做定义。输出参数：类型：ARConfig**，值：创建新的配置结构，结构地址保存到*out_config中。销毁配置接口定义：voidarConfigDestroy(ARConfig*config)功能描述：销毁配置结构。输入参数：类型：ARConfig*，值：配置结构指针。输出参数：不做定义。获取配置中的设备类型接口定义：voidarConfigGetDeviceType(constARConfig*config,ARDeviceType*out_device_type)功能描述：获取配置结构中的设备类型。输入参数：类型：constARConfig*，值：配置结构指针。输出参数：类型：ARDeviceType*，值：设备类型指针，见表2定义。设置配置中的设备类型接口定义：voidarConfigSetDeviceType(ARConfig*config,ARDeviceTypedevice_type)功能描述：设置配置结构中的设备类型。输入参数：类型：ARConfig*，值：配置结构指针。类型：ARDeviceType2获取配置中的算法数据流模式接口定义：voidarConfigGetAlgorithmStreamMode(constARConfig*configARAlgorithmTypetype,ARStreamMode*out_stream_mode)功能描述：获取配置结构中指定算法类型的数据流模式。输入参数：类型：constARConfig*，值：配置结构指针。类型：ARAlgorithmType，值：算法类型，见表5定义。输出参数：类型：ARStreamMode*，值：数据流模式指针，见表3定义。设置配置中的算法数据流模式接口定义：voidarConfigSetAlgorithmStreamMode(ARConfig*configARAlgorithmTypetype,ARStreamModestream_mode)功能描述：设置配置结构中指定算法类型的数据流模式。输入参数：类型：ARConfig*，值：配置结构指针。类型：ARAlgorithmType，值：算法类型，见表5定义。类型：ARStreamMode，值：数据流模式，见表3定义。输出参数：不做定义。获取配置中的算法开关模式接口定义：voidarConfigGetAlgorithmMode(constARConfig*configARAlgorithmTypetype,ARAlgorithmMode*out_algorithm_mode)功能描述：获取配置结构中指定算法类型的算法开关模式。输入参数：类型：constARConfig*，值：配置结构指针。类型：ARAlgorithmType，值：算法类型，见表5定义。输出参数：类型：ARAlgorithmMode*，值：算法开关模式指针，见表6定义。设置配置中的算法开关模式接口定义：voidarConfigSetAlgorithmMode(ARConfig*config,ARAlgorithmTypetype,ARAlgorithmModealgorithm_mode)功能描述：设置配置结构中指定算法类型的算法开关模式。输入参数：类型：ARConfig*，值：配置结构指针。类型：ARAlgorithmType，值：算法类型，见表5定义。类型：ARAlgorithmMode6获取配置中光照估计模式接口定义：voidarConfigGetIlluminationEstimateMode(constARConfig*config,ARIlluminationEstimateMode*out_mode)功能描述：获取配置结构中的光照估计模式。输入参数：类型：constARConfig*，值：配置结构指针。输出参数：类型：ARIlluminationEstimateMode*，值：光照估计模式指针，见表15定义。设置配置中光照估计模式接口定义：void arConfigSetIlluminationEstimateMode(ARConfig* ARIlluminationEstimateModemode)功能描述：设置配置结构中的光照估计模式。输入参数：类型：ARConfig*，值：配置结构指针。类型：ARIlluminationEstimateMode15获取配置中的跟踪运行模式接口定义：voidarConfigGetTrackingRunMode(constARConfig*config,ARTrackingRunMode*tracking_run_mode)功能描述：获取配置结构中的跟踪运行模式。输入参数：类型：constARConfig*，值：配置结构指针。输出参数：类型：ARTrackingRunMode*，值：跟踪运行模式指针，见表9定义。设置配置中的跟踪运行模式接口定义：voidarConfigSetTrackingRunMode(ARConfig*config,ARTrackingRunModetracking_run_mode)功能描述：设置配置结构中的跟踪运行模式。输入参数：类型：ARConfig*，值：配置结构指针。类型：ARTrackingRunMode9获取配置中的世界坐标对齐模式接口定义：void arConfigGetWorldAlignmentMode(const ARConfig* ARWorldAlignmentMode*world_alignment_mode)功能描述：获取配置结构中的世界坐标对齐模式。输入参数：类型：constARConfig*，值：配置结构指针。输出参数：类型：ARWorldAlignmentMode*，值：世界坐标对齐模式指针，见表10定义。设置配置中的世界坐标对齐模式接口定义：voidarConfigSetWorldAlignmentMode(ARConfig*config,ARWorldAlignmentModeworld_alignment_mode)功能描述：设置配置结构中的世界坐标对齐模式。输入参数：类型：ARConfig*，值：配置结构指针。类型：ARWorldAlignmentMode10获取配置中的参考图像数据集接口定义：voidarConfigGetReferenceImageDatabase(const ARConfig* ARReferenceImageDatabase*out_image_database)功能描述：获取配置结构中的参考图像数据集结构。输入参数：类型：constARConfig*，值：配置结构指针。输出参数：类型：ARReferenceImageDatabase*，值：参考图像数据集结构的指针。设置配置中的参考图像数据集接口定义：voidarConfigSetReferenceImageDatabase(ARConfig* config,ARReferenceImageDatabase*image_database)功能描述：设置配置结构中的参考图像数据集结构。输入参数：类型：ARConfig*，值：配置结构指针。类型：constARReferenceImageDatabase*，值：参考图像数据集结构指针。输出参数：不做定义。增强现实会话创建增强现实会话接口定义：ARResultarSessionCreate(void*envvoid*contextARSession**out_session)ARRESULT_SUCCESS输入参数：类型：void*，值：运行环境。类型：void*输出参数：类型：ARSession**，值：创建新的增强现实会话结构，结构地址保存在*out_session中，如果创建失败，*out_session指向的值为空指针。类型：ARResult，值：返回值，见表1定义。销毁增强现实会话接口定义：voidarSessionDestroy(ARSession*session)功能描述：销毁增强现实会话结构。输入参数：类型：ARSession*，值：增强现实会结构话指针。输出参数：不做定义。增强现实会话设置云服务密钥arSessionSetKeyAndSecret(ARSession*sessionconstchar*keyconstchar*secret)功能描述：授权云服务。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：constchar*，值：Key类型：constchar*，值：Secret字符串。输出参数：不做定义。增强现实会话获取版本号接口定义：voidarSessionGetVersion(constARSession*session,char*version,intversionSize)功能描述：获取版本号。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：int，值：版本号字符串数组的长度。输出参数：类型：char*，值：填充版本号的字符串。设置增强现实会话配置接口定义：ARResultarSessionConfigure(ARSession*session,constARConfig*config)功能描述：设置增强现实会话结构的配置，返回ARRESULT_SUCCESS表示成功。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：constARConfig*，值：配置指针。输出参数：类型：ARResult，值：返回值，见表1定义。获取增强现实会话配置接口定义：voidarSessionGetConfig(constARSession*session,ARConfig*out_config)功能描述：获取增强现实会话结构的配置。输入参数：类型：constARSession*，值：增强现实会话结构指针。输出参数：类型：ARConfig*，值：配置指针。恢复运行增强现实会话接口定义：ARResultarSessionResume(ARSession*session)功能描述：恢复运行增强现实会话，进入运行状态，该状态下才会对场景进行跟踪识别，返回ARRESULT_SUCCESS表示成功。输入参数：类型：ARSession*，值：增强现实会话结构指针。输出参数：类型：ARResult，值：返回值，见表1定义。暂停运行增强现实会话接口定义：ARResultarSessionPause(ARSession*session)功能描述：暂停运行增强现实会话，进入暂停状态，该状态下停止对物体场景的跟踪识别，返回ARRESULT_SUCCESS表示成功。输入参数：类型：ARSession*，值：增强现实会话结构指针。输出参数：类型：ARResult，值：返回值，见表1定义。更新增强现实会话接口定义：ARResultarSessionUpdate(ARSession*session,ARFrame*out_frame)该函数需要按照一定的频率进行调用，使增强现实会话内部信息不断更新，返回ARRESULT_SUCCESS表示成功。输入参数：类型：ARSession*，值：增强现实会话结构指针。输出参数：类型：ARFrame*，值：帧画面结构指针，需要预先创建，该结构内容会被更新。类型：ARResult1定义。启动运行增强现实会话算法接口定义：ARResultarSessionStartAlgorithm(ARSession*sessionARAlgorithmTypetype,intoption)ARRESULT_SUCCESS类型：ARSession*，值：增强现实会话结构指针。类型：ARAlgorithmType，值：算法类型，见表5定义。类型：int，值：启动算法选项。输出参数：类型：ARResult1定义。停止运行增强现实会话算法arSessionStopAlgorithm(ARSession*sessionARAlgorithmTypetypeintoption)ARRESULT_SUCCESS类型：ARSession*，值：增强现实会话结构指针。类型：ARAlgorithmType，值：算法类型，见表5定义。类型：int，值：停止算法选项。输出参数：类型：ARResult1定义。设置增强现实会话显示区域接口定义：voidarSessionSetDisplayGeometry(ARSession*sessionintrotationintwidth,intheight)功能描述：设置屏幕显示参数。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：int，值：界面朝向模式。类型：int，值：显示区域宽的像素数量。类型：int，值：显示区域高的像素数量。输出参数：不做定义。获取增强现实会话地图接口定义：ARResultarSessionAcquireWorldMap(ARSession*sessionARWorldMap**out_map)功能描述：获取增强现实会话当前的增强现实世界地图结构。输入参数：ARSession*，值：增强现实会话结构指针。输出参数：类型：ARWorldMap***out_map1定义。获取增强现实会话跟踪状态接口定义：voidarSessionGetTrackingState(ARSession*session,ARTrackingState*out_state)功能描述：获取跟踪状态，不同状态表示内部的算法运行情况，比如：初始化、正常跟踪等。输入参数：类型：ARSession*，值：增强现实会话结构指针。输出参数：类型：ARTrackingState*，值：跟踪状态指针，见表8定义。增强现实会话托管锚点接口定义：ARResultarSessionHostAnchor(ARSession*session,constARAnchor*anchor,ARAnchor**out_cloud_anchor)功能描述：将本地锚点托管至云端，创建对应的云锚点结构。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：ARAnchor*，值：本地锚点。输出参数：类型：ARAnchor**，值：创建新的云锚点结构，结构地址保存在*out_cloud_anchor。类型：ARResult1定义。增强现实会话解析锚点接口定义：ARResultarSessionResolveAnchor(ARSession*session,constchar*cloud_anchor_id,ARAnchor**out_cloud_anchor)ID类型：ARSession*，值：增强现实会话结构指针。类型：constchar*id。输出参数：id*out_cloud_anchor。类型：ARResult1定义。设置增强现实会话整型数据类型参数值接口定义：voidarSessionSetIntValue(ARSession*session,ARParameterEnumtype,int*value,intsize)功能描述：设置指定的整型数据类型参数的值。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：ARParameterEnum13类型：int，值：整形数组长度。输出参数：不做定义。设置增强现实会话浮点型数据类型参数值接口定义：voidarSessionSetFloatValue(ARSession*sessionARParameterEnumtypefloat*value,intsize)功能描述：设置指定的浮点型数据类型参数的值。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：ARParameterEnum13类型：int，值：浮点数组长度。输出参数：不做定义。设置增强现实会话字符串数据类型参数值接口定义：voidarSessionSetStringValue(ARSession*sessionARParameterEnumtypechar*value,intsize)功能描述：设置指定的字符数据类型参数的值。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：ARParameterEnum13类型：int，值：字符串数组长度。输出参数：不做定义。获取增强现实会话整型数据类型参数值接口定义：voidarSessionGetIntValue(constARSession*session,ARParameterEnumtype,int*out_value,intsize)功能描述：获取指定的整型数据类型参数的值。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：ARParameterEnum13输出参数：类型：int*，值：保存获取结果的整形数组。获取增强现实会话获取浮点型数据类型参数值接口定义：voidarSessionGetFloatValue(constARSession*sessionARParameterEnumtype,float*out_value,intsize)功能描述：获取指定的浮点型数据类型参数的值。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：ARParameterEnum13输出参数：类型：float*，值：保存获取结果的浮点数组。获取增强现实会话字符串数据类型参数值接口定义：voidarSessionGetStringValue(constARSession*sessionARParameterEnumtype,char*out_value,int*out_length,intsize)功能描述：获取指定的字符数据类型参数的值。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：ARParameterEnum13输出参数：类型：char*，值：保存获取结果的字符串数组。类型：int*，值：字符串数组被填充的长度。开始增强现实会话头戴式设备左右眼视角绘制接口定义：ARResultarSessionRenderBeginEye(ARSession*session,AREyeSideeye)功能描述：开始头戴式设备左右眼视角绘制流程状态。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：AREyeSide14类型：ARResult，值：返回值，见表1定义。结束增强现实会话头戴式设备左右眼视角绘制接口定义：ARResultarSessionEndEye(ARSession*session,AREyeSideeye)功能描述：结束头戴式设备左右眼视角绘制流程状态。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：AREyeSide14类型：ARResult，值：返回值，见表1定义。提交增强现实会话头戴式设备左右眼视角绘制结果接口定义：ARResultarSessionRenderSubmitFrame(ARSession*session,constintleftEyeTextureId,constintrightEyeTextureId)功能描述：提交左右眼视角绘制结果给增强现实会话，实现异步时间扭曲（ATW）绘制。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：constint，值：左眼离屏绘制结果纹理参数。类型：constint，值：右眼离屏绘制结果纹理参数。输出参数：类型：ARResult，值：返回值，见表1定义。设置增强现实会话头戴式设备绘制窗口环境接口定义：ARResultarSessionRenderSetWindow(ARSession*sessionvoid*window)功能描述：设置窗口环境，使异步时间扭曲（ATW）绘制框架能创建所需的绘制环境。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：void*，值：异步时间扭曲（ATW）绘制所需的窗口环境。输出参数：类型：ARResult，值：返回值，见表1定义。增强现实世界地图获取增强现实世界地图中新锚点接口定义：ARResultarWorldMapAcquireNewAnchor(ARSession*sessionARWorldMap*ar_map,constARPose*pose,ARAnchor**out_anchor)功能描述：使用指定的位姿来创建锚点。输入参数：类型：ARSession*，值：增强现实会话结构指针。类型：ARWorldMap*，值：增强现实世界地图结构指针。类型：constARPose*，值：姿态信息。输出参数：类型：ARAnchor**，值：创建新的锚点结构，结构地址保存在*out_anchor。类型：ARResult1定义。获取增强现实世界地图中所有锚点接口定义：voidarWorldMapGetAllAnchors(constARSession*session,constARWorldMap*ar_map,ARAnchorList*out_anchor_list)功能描述：获取增强现实世界地图结构中所有锚点。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARWorldMap*，值：增强现实世界地图结构指针。输出参数：类型：ARAnchorList*，值：锚点列表，需要预先创建锚点列表结构。获得增强现实世界地图中节点接口定义：voidarWorldMapGetAllNodes(constARSession*sessionconstARWorldMap*ar_map,ARNodeTypefilter_type,ARNodeList*out_node_list)ARNodeType输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARWorldMap*，值：增强现实世界地图结构指针。类型：ARNodeType，值：指定获取节点的类型，见表4定义。输出参数：类型：ARNodeList*，值：节点列表，需要预先创建节点列表结构。释放增强现实世界地图接口定义：voidarWorldMapRelease(ARWorldMap*ar_map)功能描述：释放增强现实世界地图。输入参数：类型：ARWorldMap*，值：增强现实世界地图结构指针。输出参数：不做定义。帧画面创建帧画面接口定义：voidarFrameCreate(ARSession*session,ARFrame**out_frame)功能描述：创建帧画面结构。输入参数：类型：ARSession*，值：增强现实会话结构指针。输出参数：类型：ARFrame**，值：创建新的帧画面结构，结构地址保存在*out_frame中。销毁帧画面接口定义：voidarFrameDestroy(ARFrame*out_frame)功能描述：销毁帧画面结构。输入参数：类型：ARFrame*，值：帧画面结构指针。输出参数：不做定义。判断显示区域是否发生变化接口定义：voidarFrameGetDisplayGeometryChanged(constARSession*session,constARFrame*frame,int*ut_geometry_changed)功能描述：判断显示区域是否发生了变化。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：int*，值：内容是否发生变化，0表示没有发生变化，非0为发生了变化。根据设备旋转模式转化纹理坐标arFrameTransformDisplayUvCoords(constARSession*sessionconstARFrame*frame,intnum_elements,constfloat*uvs_in,float*uvs_out);功能描述：根据设备旋转模式，将纹理坐标转化为对应旋转模式下正确的纹理坐标。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。类型：int，值：需要转化的浮点数数量。类型：constfloat*，值：需要转化的纹理坐标数组。输出参数：类型：float*，值：输出转化后的纹理坐标信息。设置点求交查询模式接口定义：voidarFrameSetPointQueryMode(constARSession*sessionconstARFrame*frame,ARQueryModemode)功能描述：设置求交查询模式。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。类型：ARQueryMode17获取点求交查询结果列表接口定义：voidarFramePointQuery(constARSession*sessionconstARFrame*framefloatpixel_x,floatpixel_y,ARQueryResultList*query_result_list)功能描述：从视点到屏幕交点投射光线，同节点求交，获得求交查询结果列表。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。类型：floatXY输出参数：类型：ARQueryResultList*，值：求交获得的查询结果列表，需要预先创建该结构。获取线求交查询结果列表接口定义：voidarFrameRayQuery(constARSession*session,constARFrame*frame,constfloat*ray_origin_3,constfloat*ray_direction_3,ARQueryResultList*hit_result_list)功能描述：发射任意一条射线，同节点求交，获得求交查询结果列表。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。类型：constfloat*3float*3输出参数：类型：ARQueryResultList*，值：求交获得的查询结果列表，需要预先创建该结构。获取当前帧的光照估计接口定义：voidarFrameGetIlluminationEstimate(constARSession*sessionconstARFrame*frame,ARIlluminationEstimate*out_light_estimate)功能描述：获取当前帧的光照估计结构。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARIlluminationEstimate*，值：光照估计结构指针，需要预先创建该结构。获取当前帧的稀疏点云接口定义：ARResultarFrameAcquirePointCloud(constARSession*session,constARFrame*frame,ARPointCloud**out_point_cloud)功能描述：创建当前帧新的稀疏点云结构。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：*out_point_cloud1定义。获取当前帧的新相机接口定义：voidarFrameAcquireCamera(constARSession*session,constARFrame*frame,ARCamera**out_camera)功能描述：创建当前帧新的相机结构。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARCamera**，值：创建新的相机结构，结构地址保存在*out_camera中。获取当前帧的稠密网格接口定义：ARResultarFrameAcquireDenseMesh(constARSession*session,constARFrame*frame,ARDenseMesh**out_dense_mesh)功能描述：创建当前帧新的稠密网格结构。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARDenseMesh**，值：创建新的稠密网格结构，结构地址保存在*out_desh_mesh中。获取更新的锚点列表接口定义：voidarFrameGetUpdatedAnchors(constARSession*sessionconstARFrame*frame,ARAnchorList*out_anchor_list)功能描述：获得更新的锚点列表，增强现实会话更新过程中，部分锚点位置等信息会发生变化。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARAnchorList*，值：锚点列表，该结构预先创建。获取更新的节点列表接口定义：voidarFrameGetUpdatedNodes(constARSession*sessionconstARFrame*frame,ARNodeTypefilter_type,ARNodeList*out_node_list);功能描述：获得更新的节点列表，增强现实会话更新过程中，部分节点位置等信息会发生变化，通过设置节点类型，可以返回指定类型的节点。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。类型：ARNodeType4输出参数：类型：ARNodeList*，值：返回节点列表，该结构预先创建。判断当前帧图像是否更新接口定义：voidarFrameIsImageUpdated(constARSession*session,constARFrame*frame,int*data_updated)功能描述：当前图像是否更新。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。类型：ARNodeType4类型：int*，值：数据内容是否更新过，非零表示更新过，0为未更新。获取当前帧图像格式接口定义：voidarFrameGetImageFormat(constARSession*session,constARFrame*frame,ARPixelFormat*video_image_format)功能描述：获取当前帧图像格式。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARPixelFormat*，值：画面的像素格式指针，见表12定义。获取当前帧图像分辨率接口定义：ARResultarFrameGetImageResolution(constARSession*sessionconstARFrame*frame,int*outwidth,int*outheight)功能描述：获取当前帧图像分辨率。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：int*，值：画面宽像素数量。类型：int*，值：画面高像素数量。类型：ARResult，值：返回值，见表1定义。获取当前帧图像数据接口定义：ARResultarFrameGetImageData(constARSession*sessionconstARFrame*frame,unsignedchar*out_data1,unsignedchar*out_data2,unsignedchar*out_data3)YUVYout_data2UV输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：unsignedchar*，值：YUVYchar*，值：YUVUVchar*，值：预留未使用。类型：ARResult，值：返回值，见表1定义。判断当前帧深度图像是否可用接口定义：ARResultarFrameIsDepthImageAvaliable(constARSession*session,constARFrame*frame)功能描述：判断当前深度图像是否可用。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARResult，值：返回值，见表1定义。获取当前帧深度图像格式接口定义：voidarFrameGetDepthImageFormat(constARSession*session,constARFrame*frame,ARPixelFormat*out_format)功能描述：获取当前帧深度图像格式。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：ARPixelFormat*，值：深度图像格式，见表12定义。获取当前帧深度图像分辨率接口定义：ARResultarFrameGetDepthImageResolution(constARSession*session,constARFrame*frame,int*out_width,int*out_height)功能描述：获取当前帧深度图像分辨率。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：int*，值：返回深度画面宽像素数量。类型：int*，值：返回深度画面高像素数量。类型：ARResult1定义。获取当前帧深度图像数据接口定义：ARResultarFrameGetDepthImageData(constARSession*session,constARFrame*frame,unsignedchar*out_depth_image_data)功能描述：获取当前帧图像数据。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARFrame*，值：帧画面结构指针。输出参数：类型：unsignedchar*，值：深度图像数据。类型：ARResult，值：返回值，见表1定义。相机模型获取相机位姿arCameraGetPose(constARSession*sessionconstARCamera*cameraARPose*out_pose)功能描述：获取相机结构的位姿信息。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARCamera*，值：相机结构指针。输出参数：类型：ARPose*，值：位姿结构指针。获取相机视图矩阵接口定义：voidarCameraGetViewMatrix(constARSession*sessionconstARCamera*camera,float*out_col_major_4x4)功能描述：获取相机结构的视图矩阵信息。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARCamera*，值：相机结构指针。输出参数：类型：float*，值：输出相机矩阵数组，是由16个单精度浮点数组成的一维数组。获取相机跟踪状态接口定义：voidarCameraGetTrackingState(constARSession*session,constARCamera*camera,ARTrackingState*out_tracking_state)功能描述：获取相机结构的跟踪状态信息。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARCamera*，值：相机结构指针。输出参数：类型：ARTrackingState*，值：相机跟踪状态指针，见表8定义。获取相机投影矩阵接口定义：voidarCameraGetProjectionMatrix(constARSession*session,constARCamera*camera,floatnear,floatfar,float*dest_col_major_4x4)功能描述：获取相机结构的投影矩阵信息。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARCamera*，值：相机结构指针。类型：float，值：相机近平面距离。类型：float，值：相机远平面距离。输出参数：类型：float*，值：输出投影矩阵数组，是由16个单精度浮点数组成的列矩阵数据。获取相机算法图像内参接口定义：voidarCameraGetImageIntrinsics(constARSession*session,constARCamera*camera,ARCameraIntrinsics*out_camera_intrinsics)功能描述：获取相机结构的图像内参信息。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARCamera*，值：相机结构指针。输出参数：类型：ARCameraIntrinsics*，值：相机图像内参参数。获取相机纹理图像内参接口定义：voidarCameraGetTextureIntrinsics(constARSession*session,constARCamera*camera,,ARCameraIntrinsics*out_camera_intrinsics);功能描述：获取相机结构的纹理内参信息。输入参数：类型：constARSession*，值：增强现实会话结构指针。类型：constARCamera*，值：相机结构指针。输出参数：类型：ARCameraI