ICS01.040.35

L60

團體標(biāo)準(zhǔn)

T/CESAXXXX—2020

信息技術(shù)移動設(shè)備增強現(xiàn)實系統(tǒng)應(yīng)用接口

Informationtechnology-Applicationinterfacesofaugmentedrealitysystemfor

mobiledevices

征求意見稿

在提交反饋意見時，請將您知道的相關(guān)專利連同支持性文件一并附上。

已授權(quán)的專利證明材料為專利證書復(fù)印件或扉頁，已公開但尚未授權(quán)的專利申請證明材料

為專利公開通知書復(fù)印件或扉頁，未公開的專利申請的證明材料為專利申請?zhí)柡蜕暾埲掌凇?/p>

2020-XX-XX發(fā)布2020-XX-XX實施

中國電子工業(yè)標(biāo)準(zhǔn)化技術(shù)協(xié)會發(fā)布

T/CESAXXXX-2020

前??言

本文件按照GB/T1.1—2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定

起草。

本文件由浙江商湯科技開發(fā)有限公司提出。

本文件由中國電子技術(shù)標(biāo)準(zhǔn)化研究院、中國電子工業(yè)標(biāo)準(zhǔn)化技術(shù)協(xié)會歸口。

本文件起草單位：浙江商湯科技開發(fā)有限公司、中國電子技術(shù)標(biāo)準(zhǔn)化研究院、浙江大學(xué)、山東大學(xué)、

北京郵電大學(xué)、OPPO廣東移動通信有限公司、北京小米移動軟件有限公司、北京愛奇藝智能科技有限公

司、北京百度網(wǎng)訊科技有限公司、網(wǎng)易（杭州）網(wǎng)絡(luò)有限公司、杭州易現(xiàn)先進科技有限公司。

本文件主要起草人：。

IV

T/CESAXXXX-2020

信息技術(shù)移動設(shè)備增強現(xiàn)實系統(tǒng)應(yīng)用接口

1范圍

本文件規(guī)定了移動設(shè)備增強現(xiàn)實系統(tǒng)應(yīng)用開發(fā)的數(shù)據(jù)類型和接口。

本文件適用于移動設(shè)備增強現(xiàn)實系統(tǒng)的設(shè)計、開發(fā)和應(yīng)用。

2規(guī)范性引用文件

下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，

僅該日期對應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本

文件。

GB/T38247-2019信息技術(shù)增強現(xiàn)實術(shù)語

T/CESAXXXXX信息技術(shù)移動設(shè)備增強現(xiàn)實系統(tǒng)技術(shù)規(guī)范

3術(shù)語和定義

GB/T38247-2019和T/CESAXXXXX界定的以及下列術(shù)語和定義適合于本文件。為了便于使用，以

下重復(fù)列出了GB/T38247—2019中的某些術(shù)語和定義。

3.1

參考圖像referenceimage

在環(huán)境中可被識別的二維圖像。

[來源：GB/T38247-2019，2.2.18]

3.2

增強現(xiàn)實會話augmentedrealitysession

負責(zé)管理增強現(xiàn)實系統(tǒng)的整個運行過程，包括創(chuàng)建、啟動、更新、關(guān)閉、銷毀等各個過程。

3.3

增強現(xiàn)實地圖augmentedrealitymap

增強現(xiàn)實運行過程中構(gòu)建的地圖結(jié)構(gòu)，包括檢測到的點云、平面節(jié)點、圖像節(jié)點等信息，以及用戶

創(chuàng)建的錨點。

3.4

節(jié)點node

增強現(xiàn)實運行過程中識別出的平面、圖像、手勢等具體對象信息。

3.5

1

T/CESAXXXX-2020

點云pointcloud

在增強現(xiàn)實應(yīng)用中，用于恢復(fù)三維場景而使用的場景物體表面的三維點數(shù)據(jù)集合。

[來源：GB/T38247-2019，2.2.47]

3.6

稠密網(wǎng)格densemesh

稠密三維重建過程中，恢復(fù)的場景三角形網(wǎng)格。

4縮略語

下列縮略語適用于本文件。

6DoF：六自由度（SixDegreesofFreedom）

AR：增強現(xiàn)實(AugmentedReality)

API：應(yīng)用程序編程接口（ApplicationProgrammingInterface）

FPS：每秒幀數(shù)（FramesPerSecond）

IMU：慣性測量單元（InertialMeasurementUnit）

SLAM：同步定位與地圖構(gòu)建（SimultaneousLocalizationAndMapping）

5總體結(jié)構(gòu)

增強現(xiàn)實系統(tǒng)總體結(jié)構(gòu)如圖1所示。

說明：

可選模塊

必選模塊

圖1增強現(xiàn)實系統(tǒng)總體結(jié)構(gòu)

2

T/CESAXXXX-2020

6數(shù)據(jù)類型

6.1結(jié)果

結(jié)果數(shù)據(jù)類型命名為ARResult，其值定義如表1所示。

表1結(jié)果數(shù)據(jù)類型ARResult定義

ARResult值描述

ARRESULT_SUCCESS=0成功或者正確。

ARRESULT_ERROR_INVALID_ARGUMENT=1包含無效參數(shù)。

ARRESULT_ERROR_FATAL=2嚴(yán)重錯誤。

ARRESULT_ERROR_SESSION_PAUSED=3當(dāng)前操作ARSession暫停狀態(tài)錯誤。

ARRESULT_ERROR_SESSION_NOT_PAUSED=4當(dāng)前操作ARSession未暫停狀態(tài)錯誤

ARRESULT_ERROR_NOT_TRACKING=5目前不處于跟蹤狀態(tài)導(dǎo)致的錯誤。

ARRESULT_ERROR_TEXTURE_NOT_SET=6未設(shè)置紋理參數(shù)導(dǎo)致的錯誤。

ARRESULT_ERROR_UNSUPPORTED_VIDEOFORMAT=7指定的視頻格式不支持錯誤。

ARRESULT_ERROR_CAMERA_NOT_AVAILABLE=8攝像機服務(wù)不可用錯誤。

ARRESULT_ERROR_CAMERA_PERMISSION_NOT_GRANTED=9攝像機服務(wù)未授權(quán)導(dǎo)致的錯誤。

ARRESULT_ERROR_UNSUPPORTED_CONFIG=10設(shè)置的配置選項不支持導(dǎo)致的錯誤。

ARRESULT_ERROR_RESOURCE_EXHAUSTED=11沒有可用資源導(dǎo)致的錯誤。

ARRESULT_ERROR_CLOUD_ANCHORS_NOT_CONFIGURED=12沒有對云錨點模式進行設(shè)置導(dǎo)致的錯誤。

ARRESULT_ERROR_ANCHOR_NOT_SUPPORTED_FOR_HOSTING=13該錨點不支持托管導(dǎo)致的錯誤。

ARRESULT_ERROR_DEVICE_UNSUPPORT=14移動設(shè)備不支持增強現(xiàn)實導(dǎo)致的錯誤。

ARRESULT_ERROR_ALGORITHM_UNSUPPORT=15使用不支持的算法導(dǎo)致的錯誤。

ARRESULT_ERROR_APPLICATION_AUTHORIZED=16該應(yīng)用未授權(quán)使用增強現(xiàn)實功能導(dǎo)致的

錯誤。

6.2設(shè)備

設(shè)備數(shù)據(jù)類型命名為ARDeviceType,其值定義如表2所示。

表2設(shè)備數(shù)據(jù)類型ARDeviceType定義

ARDeviceType值描述

ARDEVICE_TYPE_HANDHOLD=100手持式移動設(shè)備。

ARDEVICE_TYPE_HEADMOUNTED=200頭戴式移動設(shè)備。

6.3數(shù)據(jù)流模式

數(shù)據(jù)流模式數(shù)據(jù)類型命名為ARStreamMode，其值定義如表3所示。

3

T/CESAXXXX-2020

表3數(shù)據(jù)流模式數(shù)據(jù)類型ARStreamMode定義

ARStreamMode值描述

ARSTREAM_MODE_FRONT_RGB=100數(shù)據(jù)流采用前置RGB相機模式。

ARSTREAM_MODE_BACK_RGB=2000數(shù)據(jù)流采用后置RGB相機模式。

ARSTREAM_MODE_BACK_RGBD=2100數(shù)據(jù)流采用后置RGBD相機模式。

ARSTREAM_MODE_BACK_STEREO=2200數(shù)據(jù)流采用后置立體相機模式。

6.4節(jié)點

節(jié)點數(shù)據(jù)類型命名為ARNodeType，其值定義如表4所示。

表4節(jié)點數(shù)據(jù)類型ARNodeType定義

ARNodeType值描述

ARNODE_TYPE_NOT_VALID=0節(jié)點類型無效。

ARNODE_TYPE_PLANE=1平面節(jié)點類型。

ARNODE_TYPE_IMAGE=2圖像節(jié)點類型。

ARNODE_TYPE_HAND_GESTURE=3手勢節(jié)點類型。

6.5算法

算法數(shù)據(jù)類型命名為ARAlgorithmType，其值定義如表5所示。

表5算法數(shù)據(jù)類型ARAlgorithmType定義

ARAlgorithmType值描述

ARALGORITHM_TYPE_UNDEFINED=0非法算法類型。

ARALGORITHM_TYPE_SLAM=1SLAM算法類型。

ARALGORITHM_TYPE_HAND_GESTURE=2手勢算法類型。

ARALGORITHM_TYPE_DENSE_RECON=3稠密網(wǎng)格重建算法類型。

ARALGORITHM_TYPE_IMAGE_TRACKING=4圖像跟蹤算法類型。

ARALGORITHM_TYPE_PLANE_DETECTION=5平面檢測算法類型。

ARALGORITHM_TYPE_ILLUMINATION_ESTIMATION=6光照估計算法類型。

ARALGORITHM_TYPE_CLOUD_ANCHOR=7云錨點算法類型。

6.6算法模式

算法模式數(shù)據(jù)類型命名為ARAlgorithmMode，其值定義如表6所示。

表6算法模式數(shù)據(jù)類型ARAlgorithmMode定義

ARAlgorithmMode值描述

ARALGORITHM_MODE_DISABLE=0算法關(guān)閉模式。

ARALGORITHM_MODE_ENABLE=1算法激活模式。

6.7可用性

4

T/CESAXXXX-2020

可用性數(shù)據(jù)類型命名為ARAvailability，其值定義如表7所示。

表7可用性數(shù)據(jù)類型ARAvailability定義

ARAvailability值描述

ARAVAILABILITY_UNKNOWN_ERROR=0未知錯誤。

ARAVAILABILITY_UNSUPPORTED_DEVICE_NOT_CAPABLE=100設(shè)備不支持AR。

ARAVAILABILITY_SUPPORTED_NOT_INSTALLED=201設(shè)備支持，模塊未安裝導(dǎo)致不可用。

ARAVAILABILITY_SUPPORTED_VERSION_TOO_OLD=202設(shè)備支持，模塊版本太舊導(dǎo)致不可用。

ARAVAILABILITY_SUPPORTED=203設(shè)備支持，并且可用。

6.8跟蹤狀態(tài)

跟蹤狀態(tài)數(shù)據(jù)類型命名為ARTrackingState，其值定義如表8所示。

表8跟蹤狀態(tài)數(shù)據(jù)類型ARTrackingState定義

ARTrackingState值描述

ARTRACKING_STATE_SUCCESS=0正常跟蹤狀態(tài)。

ARTRACKING_STATE_LOST=1跟蹤丟失狀態(tài)。

ARTRACKING_STATE_STOPPED=2停止跟蹤狀態(tài)。

ARTRACKING_STATE_INITIALIZING=10跟蹤初始化中狀態(tài)。

6.9跟蹤運行模式

跟蹤運行模式數(shù)據(jù)類型命名為ARTrackingRunMode，其值定義如表9所示。

表9跟蹤運行模式數(shù)據(jù)類型ARTrackingRunMode定義

ARTrackingRunMode值描述

ARTRACKING_RUN_MODE_AUTO=0自動跟蹤模式，增強現(xiàn)實會話恢復(fù)運行后，算

法自動啟動運行。

ARTRACKING_RUN_MODE_MANUAL=1手動跟蹤模式，增強現(xiàn)實會話恢復(fù)運行后，算

法默認不啟動，需要手動啟動運行。

6.10世界坐標(biāo)對齊模式

世界坐標(biāo)對齊模式數(shù)據(jù)類型命名為ARWorldAlignmentMode，其值定義如表10所示。

表10世界坐標(biāo)對齊模式數(shù)據(jù)類型ARWorldAlignmentMode定義

ARWorldAlignmentMode值描述

ARWORLD_ALIGNMENT_MODE_GRAVITY0=0根據(jù)初始化時候屏幕的朝向和重力方向構(gòu)建世

界坐標(biāo)系。

ARWORLD_ALIGNMENT_MODE_GRAVITY_HEADING=1根據(jù)指南針和重力方向構(gòu)建世界坐標(biāo)系，y軸同

重力方向平行，(0,-1,0)朝下，z軸同南北方向

平行，(0,0,1)指向所在位置的朝南方向。

5

T/CESAXXXX-2020

6.11頂點格式

頂點格式數(shù)據(jù)類型命名為ARVertexFormat，其值定義如表11所示。

表11頂點格式數(shù)據(jù)類型ARVertexFormat定義

ARVertexFormat值描述

ARVERTEX_FORMAT_3D_POSITION=0頂點數(shù)據(jù)包含3個float值，表示該點坐標(biāo)。

ARVERTEX_FORMAT_3D_POSITION_NORMAL=1頂點數(shù)據(jù)包含6個float值，表示該點坐標(biāo)和

經(jīng)過該點的平面法線向量。

ARVERTEX_FORMAT_3D_POSITION_NORMAL_COLOR=2頂點數(shù)據(jù)包含10個float值，表示該點坐標(biāo)、

經(jīng)過該點的平面法線向量和該點的RGBA數(shù)據(jù)。

ARVERTEX_FORMAT_NOT_VALID=3非法頂點數(shù)據(jù)。

6.12像素格式

像素格式數(shù)據(jù)類型命名為ARPixelFormat，其值定義如表12所示。

表12像素格式數(shù)據(jù)類型ARPixelFormat定義

ARPixelFormat值描述

ARPIXEL_FORMAT_UNKNOWN=-1非法圖像數(shù)據(jù)。

ARPIXEL_FORMAT_LUMINANCE8=0圖像數(shù)據(jù)采用LUMINANCE8格式。

ARPIXEL_FORMAT_RG16=1圖像數(shù)據(jù)采用RG16格式。

ARPIXEL_FORMAT_RGB24=2圖像數(shù)據(jù)采用RGB24格式。

ARPIXEL_FORMAT_RGBA32=3圖像數(shù)據(jù)采用RGBA32格式。

ARPIXEL_FORMAT_DEPTH16=4圖像數(shù)據(jù)采用Depth16格式。

ARPIXEL_FORMAT_YUV_NV21=1000圖像數(shù)據(jù)采用YUVNV21格式。

6.13參數(shù)

參數(shù)數(shù)據(jù)類型命名為ARParameterEnum，其值定義如表13所示。

表13參數(shù)數(shù)據(jù)類型ARParameterEnum定義

ARParameterEnum值描述

ARPARAMETER_VIDEO_VERTICAL_FOV=50視頻垂直方向FOV。

ARPARAMETER_ALGORITHM_SLAM_INFO=100SLAM算法運行信息。

ARPRARMETER_ALGORITHM_SLAM_MAP_QUALITY=101SLAM地圖質(zhì)量。

ARPARAMETER_ALGORITHM_SLAM_DETAIL_STATE=102SLAM算法內(nèi)部詳細的運行狀態(tài)。

ARPARAMETER_CAMERA_TEXTURE_TARGET=3000視頻流紋理ID。

6

T/CESAXXXX-2020

6.14左右眼

左右眼數(shù)據(jù)類型命名為AREyeSide，其值定義如表14所示。

表14左右眼數(shù)據(jù)類型AREyeSide定義

AREyeSide值描述

AREYE_LEFT=0左眼。

AREYE_RIGHT=1右眼。

6.15光照估計模式

光照估計模式數(shù)據(jù)類型命名為ARIlluminationEstimateMode，其值定義如表15所示。

表15光照估計模式數(shù)據(jù)類型ARIlluminationEstimateMode定義

ARIlluminationEstimateMode值描述

ARILLUMINATION_ESTIMATE_MODE_AMBIENT_INTENSITY=1環(huán)境光亮度模式，包含單一亮度值。

6.16光照估計狀態(tài)

光照估計狀態(tài)數(shù)據(jù)類型命名為ARIlluminationEstimateState，其定義如表16所示。

表16光照估計狀態(tài)數(shù)據(jù)類型ARIlluminationEstimateState定義

ARIlluminationEstimateState值描述

ARILLUMINATION_ESTIMATE_STATE_NOT_VALID=0光照估計結(jié)果暫時還不可用。

ARILLUMINATION_ESTIMATE_STATE_VALID=1光照估計結(jié)果可用

6.17求交查詢模式

求交查詢模式數(shù)據(jù)類型命名為ARQueryMode，其值定義如表17所示。

表17求交查詢模式數(shù)據(jù)類型ARQueryMode定義

ARQueryMode值描述

ARQUERY_MODE_POLYGON_ONLY=0只能跟多邊形平面求交查詢。

ARQUERY_MODE_POLYGON_AND_HORIZONPLANE=1能跟多邊形平面以及水平多邊形所在整個

無限平面求交查詢。

ARQUERY_MODE_POLYGON_PERSISTENCE=2能跟多邊形平面以及多邊形平面所在的無

限平面求交查詢，多邊形平面優(yōu)先。

6.18云錨點狀態(tài)

云錨點狀態(tài)數(shù)據(jù)類型命名為ARCloudAnchorState，其值定義如表18所示。

7

T/CESAXXXX-2020

表18云錨點狀態(tài)數(shù)據(jù)類型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托管或解析發(fā)生內(nèi)部錯誤。

ARCLOUD_ANCHOR_STATE_ERROR_NOT_AUTHORIZED=-2托管或解析沒有被授權(quán)。

ARCLOUD_ANCHOR_STATE_ERROR_SERVICE_UNAVAILABLE=-3當(dāng)前服務(wù)不可用。

ARCLOUD_ANCHOR_STATE_ERROR_RESOURCE_EXHAUSTED=-4資源已經(jīng)被用盡。

ARCLOUD_ANCHOR_STATE_ERROR_HOSTING_DATASET_PROCESSING_FAILED=-5云錨點數(shù)據(jù)錯誤，不能托管。

ARCLOUD_ANCHOR_STATE_ERROR_CLOUD_ID_NOT_FOUND=-6該云錨點ID沒有被找到。

ARCLOUD_ANCHOR_STATE_ERROR_RESOLVING_LOCALIZATION_NO_MATCH=-7解析失敗，環(huán)境無法匹配。

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未知錯誤。

6.19平面

平面數(shù)據(jù)類型命名為ARPlaneType，其值定義如表19所示。

表19平面數(shù)據(jù)類型ARPlaneType定義

ARPlaneType值描述

ARPLANE_TYPE_UPWARD_FACING=0水平平面朝上類型。

ARPLANE_TYPE_DOWNWARD_FACING=1水平平面朝下類型。

ARPLANE_TYPE_VERTICAL=2垂直平面類型。

ARPLANE_TYPE_NOT_VALID=3無效平面類型。

6.20手勢

手勢數(shù)據(jù)類型命名為ARHandGestureType，其值定義如表20所示。

表20手勢數(shù)據(jù)類型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做得好手勢獲取類型。

8

T/CESAXXXX-2020

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小拇指手勢獲取類型。

6.21左右手

左右手數(shù)據(jù)類型命名為ARHandSide，其值定義如表21所示。

表21左右手數(shù)據(jù)類型ARHandSide定義

ARHandSide值描述

ARHAND_SIDE_HAND_UNKNOWN=-1無法區(qū)分左右手。

ARHAND_SIDE_RIGHT_HAND=0右手。

ARHAND_SIDE_LEFT_HAND=1左手。

6.22手掌心朝向

手掌心朝向數(shù)據(jù)類型命名為ARHandTowards，其值定義如表22所示。

表22手掌心朝向數(shù)據(jù)類型ARHandTowards定義

ARHandTowards值描述

ARHAND_TOWARDS_UNKNOWN=-1無效的手朝向。

ARHAND_TOWARDS_PALM=0手心方向。

ARHAND_TOWARDS_THE_BACK_OF_HAND=1手背方向。

ARHAND_TOWARDS_SIDE_HAND=2側(cè)手方向。

7接口

7.1功能擴展

7.1.1獲取擴展函數(shù)地址

接口定義：PFN_xrVoidFunctionarGetProcAddress(constchar*name)

功能描述：通過給定的字符串，獲取功能擴展的函數(shù)指針。

輸入?yún)?shù)：

類型：constchar*，值：函數(shù)指針的名字。

輸出參數(shù)：

類型：PFN_xrVoidFunction，值：typedefvoid(ARAPI_PTR*PFN_arVoidFunction)(void)，

定義了函數(shù)指針的類型，ARAPI_PTR定義的是調(diào)用方式，當(dāng)無法獲取到指定名字的函數(shù)指針的時候，

返回空指針。

7.2能力檢測

7.2.1檢測設(shè)備是否支持

接口定義：voidarCapabilityCheckAvailability(void*env,void*context,ARAvailability*

9

T/CESAXXXX-2020

out_availability)

功能描述：檢測設(shè)備是否支持運行增強現(xiàn)實模塊。

輸入?yún)?shù)：

類型：void*，值：運行環(huán)境。

類型：void*，值：運行上下文。

輸出參數(shù)：

類型：ARAvailability*，值：是否可用，參照ARAvailability定義。

7.2.2檢測是否支持算法

接口定義：ARResultarCapabilityCheckAlgorithm(void*env,void*context,ARAlgorithmType

type,ARStreamModemode)

功能描述：檢測設(shè)備是否支持給定數(shù)據(jù)流模式的算法，返回ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：void*，值：運行環(huán)境。

類型：void*，值：運行上下文。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

類型：ARStreamMode，值：數(shù)據(jù)流模式，參考ARStreamMode定義。

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.2.3檢測是否授權(quán)

接口定義：ARResultarCapabilityCheckAuthorized(void*env,void*context,constchar*

appId)

功能描述：檢測應(yīng)用程序是否授權(quán)運行增強現(xiàn)實模塊，返回ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：void*，值：運行環(huán)境。

類型：void*，值：運行上下文。

類型：constchar*，值：應(yīng)用程序授權(quán)字符串。

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.3位姿

7.3.1創(chuàng)建位姿

接口定義：voidarPoseCreate(constfloat*pose_raw,ARPose**out_pose)

功能描述：創(chuàng)建位姿結(jié)構(gòu)，數(shù)組參數(shù)為6DoF信息（qx,qy,qz,qw,tx,ty,tz），數(shù)組長度為7。

輸入?yún)?shù)：

類型：constfloat*，值：6DoF信息。

輸出參數(shù)：

類型：ARPose**，值：創(chuàng)建新的位姿結(jié)構(gòu)，結(jié)構(gòu)地址保存到*out_pose中。

7.3.2釋放位姿

接口定義：voidarPoseDestroy(ARPose*pose)

10

T/CESAXXXX-2020

功能描述：銷毀位姿結(jié)構(gòu)。

輸入?yún)?shù)：

類型：ARPose*，值：位姿結(jié)構(gòu)指針。

輸出參數(shù)：不作定義。

7.3.3獲取位姿結(jié)構(gòu)的6DoF信息

接口定義：voidarPoseGetPoseRaw(constARPose*pose,float*out_pose_raw)

功能描述：獲取位姿結(jié)構(gòu)對應(yīng)的6DoF信息（qx,qy,qz,qw,tx,ty,tz），數(shù)組長度為7。

輸入?yún)?shù)：

類型：constARPose*，值：位姿結(jié)構(gòu)指針。

輸出參數(shù)：

類型：float*，值：6DoF信息。

7.3.4獲取位姿結(jié)構(gòu)的矩陣

接口定義：voidarPoseGetMatrix(constARPose*pose,float*out_matrix_col_major_4x4)

功能描述：獲取位姿結(jié)構(gòu)對應(yīng)的4×4矩陣。

輸入?yún)?shù)：

類型：constARPose*，值：位姿結(jié)構(gòu)指針。

輸出參數(shù)：

類型：float*，值：矩陣，該矩陣為列矩陣形式。

7.4配置

7.4.1創(chuàng)建配置

接口定義：voidarConfigCreate(ARConfig**out_config)

功能描述：創(chuàng)建配置結(jié)構(gòu)。

輸入?yún)?shù)：不做定義。

輸出參數(shù)：

類型：ARConfig**，值：創(chuàng)建新的配置結(jié)構(gòu)，結(jié)構(gòu)地址保存到*out_config中。

7.4.2銷毀配置

接口定義：voidarConfigDestroy(ARConfig*config)

功能描述：銷毀配置結(jié)構(gòu)。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

輸出參數(shù)：不做定義。

7.4.3獲取配置中的設(shè)備類型

接口定義：voidarConfigGetDeviceType(constARConfig*config,ARDeviceType*

out_device_type)

功能描述：獲取配置結(jié)構(gòu)中的設(shè)備類型。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

11

T/CESAXXXX-2020

輸出參數(shù)：

類型：ARDeviceType*，值：設(shè)備類型指針，參考ARDeviceType定義。

7.4.4設(shè)置配置中的設(shè)備類型

接口定義：voidarConfigSetDeviceType(ARConfig*config,ARDeviceTypedevice_type)

功能描述：設(shè)置配置結(jié)構(gòu)中的設(shè)備類型。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARDeviceType，值：設(shè)備類型，參考ARDeviceType定義。

輸出參數(shù)：不做定義。

7.4.5獲取配置中的算法數(shù)據(jù)流模式

接口定義：voidarConfigGetAlgorithmStreamMode(constARConfig*config,ARAlgorithmType

type,ARStreamMode*out_stream_mode)

功能描述：獲取配置結(jié)構(gòu)中指定算法類型的數(shù)據(jù)流模式。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

輸出參數(shù)：

類型：ARStreamMode*，值：數(shù)據(jù)流模式指針，參考ARStreamMode定義。

7.4.6設(shè)置配置中的算法數(shù)據(jù)流模式

接口定義：voidarConfigSetAlgorithmStreamMode(ARConfig*config,ARAlgorithmTypetype,

ARStreamModestream_mode)

功能描述：設(shè)置配置結(jié)構(gòu)中指定算法類型的數(shù)據(jù)流模式。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

類型：ARStreamMode，值：數(shù)據(jù)流模式，參考ARStreamMode定義。

輸出參數(shù)：不做定義。

7.4.7獲取配置中的算法開關(guān)模式

接口定義：voidarConfigGetAlgorithmMode(constARConfig*config,ARAlgorithmTypetype,

ARAlgorithmMode*out_algorithm_mode)

功能描述：獲取配置結(jié)構(gòu)中指定算法類型的算法開關(guān)模式。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

輸出參數(shù)：

類型：ARAlgorithmMode*，值：算法開關(guān)模式指針，參考ARAlgorithmMode定義。

7.4.8設(shè)置配置中的算法開關(guān)模式

接口定義：voidarConfigSetAlgorithmMode(ARConfig*config,ARAlgorithmTypetype,

12

T/CESAXXXX-2020

ARAlgorithmModealgorithm_mode)

功能描述：設(shè)置配置結(jié)構(gòu)中指定算法類型的算法開關(guān)模式。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

類型：ARAlgorithmMode，值：算法開關(guān)模式，參考ARAlgorithmMode定義。

輸出參數(shù)：不做定義。

7.4.9獲取配置中光照估計模式

接口定義：voidarConfigGetIlluminationEstimateMode(constARConfig*config,

ARIlluminationEstimateMode*out_mode)

功能描述：獲取配置結(jié)構(gòu)中的光照估計模式。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARIlluminationEstimateMode*，值：光照估計模式指針，參考

ARIlluminationEstimateMode定義。

7.4.10設(shè)置配置中光照估計模式

接口定義：voidarConfigSetIlluminationEstimateMode(ARConfig*config,

ARIlluminationEstimateModemode)

功能描述：設(shè)置配置結(jié)構(gòu)中的光照估計模式。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARIlluminationEstimateMode，值：光照估計模式，參考ARIlluminationEstimateMode

定義。

輸出參數(shù)：不做定義。

7.4.11獲取配置中的跟蹤運行模式

接口定義：voidarConfigGetTrackingRunMode(constARConfig*config,ARTrackingRunMode*

tracking_run_mode)

功能描述：獲取配置結(jié)構(gòu)中的跟蹤運行模式。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARTrackingRunMode*，值：跟蹤運行模式指針，參考ARTrackingRunMode定義。

7.4.12設(shè)置配置中的跟蹤運行模式

接口定義：voidarConfigSetTrackingRunMode(ARConfig*config,ARTrackingRunMode

tracking_run_mode)

功能描述：設(shè)置配置結(jié)構(gòu)中的跟蹤運行模式。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

13

T/CESAXXXX-2020

類型：ARTrackingRunMode，值：跟蹤運行模式，參考ARTrackingRunMode定義。

輸出參數(shù)：不做定義。

7.4.13獲取配置中的世界坐標(biāo)對齊模式

接口定義：voidarConfigGetWorldAlignmentMode(constARConfig*config,

ARWorldAlignmentMode*world_alignment_mode)

功能描述：獲取配置結(jié)構(gòu)中的世界坐標(biāo)對齊模式。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARWorldAlignmentMode*，值：世界坐標(biāo)對齊模式指針，參考ARWorldAlignmentMode

定義。

7.4.14設(shè)置配置中的世界坐標(biāo)對齊模式

接口定義：voidarConfigSetWorldAlignmentMode(ARConfig*config,ARWorldAlignmentMode

world_alignment_mode)

功能描述：設(shè)置配置結(jié)構(gòu)中的世界坐標(biāo)對齊模式。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

類型：ARWorldAlignmentMode，值：世界坐標(biāo)對齊模式，參考ARWorldAlignmentMode定義。

輸出參數(shù)：不做定義。

7.4.15獲取配置中的參考圖像數(shù)據(jù)集

接口定義：voidarConfigGetReferenceImageDatabase(constARConfig*config,

ARReferenceImageDatabase*out_image_database)

功能描述：獲取配置結(jié)構(gòu)中的參考圖像數(shù)據(jù)集結(jié)構(gòu)。

輸入?yún)?shù)：

類型：constARConfig*，值：配置結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARReferenceImageDatabase*，值：參考圖像數(shù)據(jù)集結(jié)構(gòu)的指針。

7.4.16設(shè)置配置中的參考圖像數(shù)據(jù)集

接口定義：voidarConfigSetReferenceImageDatabase(ARConfig*config,const

ARReferenceImageDatabase*image_database)

功能描述：設(shè)置配置結(jié)構(gòu)中的參考圖像數(shù)據(jù)集結(jié)構(gòu)。

輸入?yún)?shù)：

類型：ARConfig*，值：配置結(jié)構(gòu)指針。

類型：constARReferenceImageDatabase*，值：參考圖像數(shù)據(jù)集結(jié)構(gòu)指針。

輸出參數(shù)：不做定義。

7.5增強現(xiàn)實會話

7.5.1創(chuàng)建增強現(xiàn)實會話

14

T/CESAXXXX-2020

接口定義：ARResultarSessionCreate(void*env,void*context,ARSession**out_session)

功能描述：創(chuàng)建增強現(xiàn)實會話結(jié)構(gòu)，返回ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：void*，值：運行環(huán)境。

類型：void*，值：運行上下文。

輸出參數(shù)：

類型：ARSession**，值：創(chuàng)建新的增強現(xiàn)實會話結(jié)構(gòu)，結(jié)構(gòu)地址保存在*out_session中，如

果創(chuàng)建失敗，*out_session指向的值為空指針。

類型：ARResult，值：返回值，參考ARResult定義。

7.5.2銷毀增強現(xiàn)實會話

接口定義：voidarSessionDestroy(ARSession*session)

功能描述：銷毀增強現(xiàn)實會話結(jié)構(gòu)。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會結(jié)構(gòu)話指針。

輸出參數(shù)：不做定義。

7.5.3增強現(xiàn)實會話設(shè)置云服務(wù)密鑰

接口定義：voidarSessionSetKeyAndSecret(ARSession*session,constchar*key,constchar*

secret)

功能描述：授權(quán)云服務(wù)。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

類型：constchar*，值：Key字符串。

類型：constchar*，值：Secret字符串。

輸出參數(shù)：不做定義。

7.5.4增強現(xiàn)實會話獲取版本號

接口定義：voidarSessionGetVersion(constARSession*session,char*version,int

versionSize)

功能描述：獲取版本號。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

類型：int，值：版本號字符串?dāng)?shù)組的長度。

輸出參數(shù)：

類型：char*，值：填充版本號的字符串。

7.5.5設(shè)置增強現(xiàn)實會話配置

接口定義：ARResultarSessionConfigure(ARSession*session,constARConfig*config)

功能描述：設(shè)置增強現(xiàn)實會話結(jié)構(gòu)的配置，返回ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

類型：constARConfig*，值：配置指針。

15

T/CESAXXXX-2020

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.5.6獲取增強現(xiàn)實會話配置

接口定義：voidarSessionGetConfig(constARSession*session,ARConfig*out_config)

功能描述：獲取增強現(xiàn)實會話結(jié)構(gòu)的配置。

輸入?yún)?shù)：

類型：constARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARConfig*，值：配置指針。

7.5.7恢復(fù)運行增強現(xiàn)實會話

接口定義：ARResultarSessionResume(ARSession*session)

功能描述：恢復(fù)運行增強現(xiàn)實會話，進入運行狀態(tài)，該狀態(tài)下才會對場景進行跟蹤識別，返回

ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.5.8暫停運行增強現(xiàn)實會話

接口定義：ARResultarSessionPause(ARSession*session)

功能描述：暫停運行增強現(xiàn)實會話，進入暫停狀態(tài)，該狀態(tài)下停止對物體場景的跟蹤識別，返回

ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.5.9更新增強現(xiàn)實會話

接口定義：ARResultarSessionUpdate(ARSession*session,ARFrame*out_frame)

功能描述：更新增強現(xiàn)實會話的內(nèi)部數(shù)據(jù)，例如更新設(shè)備姿態(tài)信息，識別的平面節(jié)點、圖像節(jié)點。

該函數(shù)需要按照一定的頻率進行調(diào)用，使增強現(xiàn)實會話內(nèi)部信息不斷更新，返回ARRESULT_SUCCESS表

示成功。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

輸出參數(shù)：

類型：ARFrame*，值：幀畫面結(jié)構(gòu)指針，需要預(yù)先創(chuàng)建，該結(jié)構(gòu)內(nèi)容會被更新。

類型：ARResult，值：返回值，參考ARResult定義。

7.5.10啟動運行增強現(xiàn)實會話算法

接口定義：ARResultarSessionStartAlgorithm(ARSession*session,ARAlgorithmTypetype,int

option)

16

T/CESAXXXX-2020

功能描述：手動方式啟動算法，返回ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

類型：int，值：啟動算法選項。

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.5.11停止運行增強現(xiàn)實會話算法

接口定義：ARResultarSessionStopAlgorithm(ARSession*session,ARAlgorithmTypetype,int

option)

功能描述：手動方式停止算法，返回ARRESULT_SUCCESS表示成功。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

類型：ARAlgorithmType，值：算法類型，參考ARAlgorithmType定義。

類型：int，值：停止算法選項。

輸出參數(shù)：

類型：ARResult，值：返回值，參考ARResult定義。

7.5.12設(shè)置增強現(xiàn)實會話顯示區(qū)域

接口定義：voidarSessionSetDisplayGeometry(ARSession*session,introtation,intwidth,

intheight)

功能描述：設(shè)置屏幕顯示參數(shù)。

輸入?yún)?shù)：

類型：ARSession*，值：增強現(xiàn)實會話結(jié)構(gòu)指針。

類型：int，值：手機界面朝向模式。

類型：int，值：顯示區(qū)域?qū)挼南袼財?shù)量。

類型：int，值：顯示區(qū)域高的像素數(shù)量。

輸出參數(shù)：不做定義。

7.5.13獲取增強現(xiàn)實會話地圖

接口定義：ARResultarSessionAcquireWorldMap(ARSession*session,ARWorldMap**out_map)

功能描述：獲取增強現(xiàn)實會話當(dāng)