玩瞳文档中心


SDK基础接口

<h3>概述</h3> <p>该部分接口的入口类为 <strong>VTBRSDKManager</strong></p> <h3>1. 获取VTBRSDKManager实例</h3> <p><strong> sdk版本为v3.1.0及以上支持去封面识别 </strong></p> <p><strong>接口名称:</strong></p> <pre><code class="language-java">VTBRSDKManager(@NonNull Context context) VTBRSDKManager(@NonNull Context context,int width, int height) VTBRSDKManager(@NonNull Context context, int width, int height, @RecognizeModel int model)//v3.1.1版本及以上</code></pre> <p><strong>参数:</strong> model值:</p> <ul> <li>RecognizeModel.AUTO_RECOGNIZE_MODEL : 自动识别模式</li> <li>RecognizeModel.TAKE_PICTURE_MODEL : 拍照识别模式</li> </ul> <table> <thead> <tr> <th>参数名</th> <th>说明</th> <th>类型</th> </tr> </thead> <tbody> <tr> <td>context</td> <td>Activity的Context,不能为NULL</td> <td>Context</td> </tr> <tr> <td>width</td> <td>预览分辨率宽</td> <td>int</td> </tr> <tr> <td>height</td> <td>预览分辨率高</td> <td>int</td> </tr> <tr> <td>model</td> <td>当前使用的模式是自动识别还是拍照识别</td> <td>@RecognizeModel int</td> </tr> </tbody> </table> <h3>2. 开启SDK</h3> <p><strong>接口名称:</strong></p> <pre><code class="language-java">public void init()</code></pre> <p><strong>备注:</strong></p> <p>在调用sdk的其他功能接口前,需要调用下这个方法初始化一些参数和配置,否则会导致一些功能无法使用。</p> <h3>3. 关闭SDK</h3> <p><strong>接口名称:</strong></p> <pre><code class="language-java">public void onDestory()</code></pre> <p><strong>备注:</strong></p> <p>该方法用于退出SDK,会关闭以下功能:</p> <ul> <li>音频模块:不会再播放书页音频;</li> <li>识别模块:不再进行识别;</li> <li>网络模块:取消掉当前的网络请求队列;</li> </ul> <h3>4. license认证</h3> <p><strong>接口名称:</strong></p> <pre><code class="language-java">public void initialize(String license, IInitializeListener listener)</code></pre> <p><strong>参数:</strong></p> <table> <thead> <tr> <th>参数名</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>license</td> <td>String</td> <td>授权license</td> </tr> <tr> <td>listener</td> <td>IInitializeListener</td> <td>初始化回调</td> </tr> </tbody> </table> <p><strong>备注:</strong></p> <p>在调用识别功能接口前,<strong>必须先调用此方法</strong>,初始化的状态回调通过<code>IInitializeListener</code>来监听</p> <h3>5. IInitializeListener初始化回调</h3> <p>该回调类用于监听initialize方法的回调结果,接口类如下:</p> <pre><code class="language-java">/** * 初始化失败 * * @param errCode 错误码 * @param msg */ void onInitFail(int errCode, String msg); /** * 初始化成功 */ void onInitSuccess();</code></pre> <h3>6. 获取SDK版本号</h3> <pre><code>com.visiontalk.vtbrsdk.BuildConfig.VERSION_NAME</code></pre> <h3>7. 获取deviceID</h3> <p>备注:1.4.2版本之后开放;第一次启动app时,需调用 <strong>init</strong> 初始化SDK方法后才能正确获取;获取方式:VTBaseSDKManager.getInstance().getDeviceID();</p> <pre><code class="language-java">@Nullable public String getDeviceID()</code></pre> <h3>8. 获取openID</h3> <p>备注:1.4.2版本之后开放;需调用 <strong>initialize</strong> 方法检验license<strong>成功</strong>(回调onInitSuccess())后才能正确获取。获取方式:VTBaseSDKManager.getInstance().getOpenID();</p> <pre><code class="language-java">@Nullable public String getOpenID()</code></pre> <h3>9. 设置识别新页后延迟响应手指点读时间</h3> <p>备注:目前体验在1.5秒比较合适,实际参数需要根据用户习惯、设备性能等综合考虑</p> <pre><code class="language-java">public void setFingerBreakAudioDelayMS(long delay)</code></pre> <h3>10. 设置手指偏移量</h3> <pre><code class="language-java">public void setupFingerPointOffset(int xOffset, int yOffset)</code></pre> <h3>11. 设置多框模式</h3> <p>备注:目前mode默认值为4,,multi默认值为false,如客户个人处理点读逻辑有多框需求时,可将model置为1,multi置为true</p> <pre><code class="language-java">/** * 设置手指检测模式 参见FingerDetectMode * * @param modeCode 0, 绝对击中不返回近邻,1, 加入垂直方向近邻框(推荐),3, 加入任意方向近邻框,4, 加入垂直方向近邻框,且近邻框在点上方 */ public void setFingerDetectMode(int modeCode) /** * 设置当前点读是否返回多框 默认只返回符合点读策略的最优框 * * @param flag true 返回符合点读策略的多个框 */ public void updateMultiFramesFlag(boolean flag)</code></pre> <h3>12.获取书本信息接口</h3> <p>备注:参数 为bookId 或者securityId; 返回参数请参考《识别接口》文档5.4部分[获取书本信息回调](<a href="https://www.showdoc.cc/visiontalk?page_id=2174768913664731">https://www.showdoc.cc/visiontalk?page_id=2174768913664731</a> &quot;获取书本信息回调&quot;)</p> <pre><code class="language-java">public void downloadBookRes(String securityId)</code></pre> <p>[5.4]: <a href="https://www.showdoc.cc/visiontalk?page_id=2174768913664731">https://www.showdoc.cc/visiontalk?page_id=2174768913664731</a> &quot;获取书本信息回调&quot; [5.4]: <a href="https://www.showdoc.cc/visiontalk?page_id=2174768913664731">https://www.showdoc.cc/visiontalk?page_id=2174768913664731</a> &quot;获取书本信息回调&quot;</p>

页面列表

ITEM_HTML