# VKSession

基础库 2.20.0 开始支持,低版本需做兼容处理

vision kit 会话对象。

# 属性

# number state

会话状态

state 的合法值

说明 最低版本
0 不可用
1 运行中
2 暂停中

# Object config

会话配置

属性 类型 说明
track Object 跟踪配置
结构属性 类型 说明
plane Object 平面跟踪配置
结构属性 类型 说明
mode number 平面跟踪配置模式,目前只支持 1(检测横向平面)

# Object cameraSize

相机尺寸

属性 类型 说明
width number 宽度
height number 高度

# 方法

# VKSession.start(VKSessionStartCallback callback)

开启会话。

# VKSession.stop()

停止会话。

# VKSession.destroy()

销毁会话。

# number VKSession.requestAnimationFrame(function callback)

在下次进行重绘时执行。

# VKSession.cancelAnimationFrame(number requestID)

取消由 requestAnimationFrame 添加到计划中的动画帧请求。

# VKFrame VKSession.getVKFrame(number width, number height)

获取帧对象,每调用一次都会触发一次帧分析过程。

# Array.<HitTestRes> VKSession.hitTest(number x, number y, Object reset)

触摸检测,目前只支持单平面(即 hitTest 生成一次平面后,后续 hitTest 均不会再生成平面,而是以之前生成的平面为基础进行检测)。如果需要重新识别其他平面,可以在调用此方法时将 reset 参数置为 true。

# VKSession.on(string eventName, function fn)

监听会话事件。

# VKSession.off(string eventName, function fn)

取消监听会话事件。