EasyARSession Class

Description

在场景中控制AR会话,控制整个生命周期的数据流。 这个组件是AR的入口。同一时刻不允许出现多个active的实例。 EasyAR组件的所有功能必须在 Session 初始化完成之后才能使用。


Properties

state

TypeScript

state: `SessionState`_

获取Session当前状态

xrCamera

TypeScript

xrCamera: xrfs.XRCamera

获取Session使用的场景中的XRCamera

blockHolder

TypeScript

blockHolder: `BlockHolder`_

获取BlockHolder

megaTracker

TypeScript

megaTracker: `MegaTracker`_

获取MegaTracker


Methods

start

TypeScript

start(options?: `SessionStartOptions`_ ): Promise<void>

options?: SessionStartOptions ; options 启动选项,可选。 启动Session。

stop

TypeScript

stop(): void

停止Session,此时所有BlockController及Session使用的Tracker会被销毁。

pause

TypeScript

pause(): void

暂停ARSession,Tracker及相机的更新将停止(注意此时不会被xrframe重新控制)。

resume

TypeScript

resume(): void

恢复ARSession,Tracker及相机的更新将恢复。

setDeviceOrientation

TypeScript

setDeviceOrientation(deviceOrientation: `DeviceOrientation`_ ): void

deviceOrientation: DeviceOrientation ; 当前设备朝向。 设置当前设备朝向。可随时调用,立即生效。

setGeoLocationInput

TypeScript

setGeoLocationInput(inputMode: `GeoLocationInputMode`_ , geoLocation?: `GeoLocation`_ ): void

inputMode: GeoLocationInputMode ; GPS输入模式。 geoLocation?: GeoLocation ; GPS信息。 设置当前GPS输入模式。只能在Session.start前调用,start后生效。

loadAnnotation

TypeScript

loadAnnotation(id: string): Promise<`ema`_ .IEma>

id: string; annotationID。 加载标注。只能在Session.start成功后调用。

dumpLog

TypeScript

dumpLog(signal: boolean): string

signal: boolean; 传入true为开始,false为结束。 开始和结束记录日志。可随时调用。

setPlaneDetectionErrorBehavior

TypeScript

setPlaneDetectionErrorBehavior(behavior: () => void): void

behavior: () => void; 传入回调函数。 设置微信小程序平面检测异常时的行为