API说明

<p><strong>简要描述：</strong> </p> <ul> <li>该SDK专为小系统，低内存机器提供绘本阅读等能力，方便移植到各种小系统平台</li> </ul> <p><strong>函数接口名：</strong></p> <ul> <li>struct vt_bk_handle *vt_bk_instance() 【创建绘本实例句柄】</li> </ul> <p><strong>参数：</strong> 无</p> <p><strong>返回值说明</strong> 返回空失败，非空成功，该接口总是返回成功</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_env_init(struct vt_bk_handle <em>handle, const char </em>license_raw_text, const char <em>device_id, const char</em> model_type) 【初始化绘本环境变量】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">license_raw_text</td> <td style="text-align: left;">是</td> <td style="text-align: left;">字符串</td> <td>license原始内容</td> </tr> <tr> <td style="text-align: left;">device_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">字符串</td> <td>机器唯一设备ID</td> </tr> <tr> <td style="text-align: left;">model_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">字符串</td> <td>机器机型配置【玩瞳获取开通】</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_login(struct vt_bk_handle *handle, pfun_vt_httpRequest_cb cb) 【登陆绘本】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">cb</td> <td style="text-align: left;">是</td> <td style="text-align: left;">函数指针</td> <td>登陆网络请求函数，license校验通过后会回调此函数进行登陆，外部需要保存好登陆返回的cookie用于后续请求</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_register_camera_ops(struct vt_bk_handle <em>handle, const camera_ops_t </em>ops) 【注册相机接口】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">ops</td> <td style="text-align: left;">是</td> <td style="text-align: left;">结构指针</td> <td>相机操作方法集</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_register_mediaplayer_ops(struct vt_bk_handle <em>handle, const media_player_ops_t </em>ops) 【注册播放器接口】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">ops</td> <td style="text-align: left;">是</td> <td style="text-align: left;">结构指针</td> <td>播放器操作方法集</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_register_os_wrapper(struct vt_bk_handle <em>handle, const vt_os_ops_t </em>ops) 【注册OS功能操作函数】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">ops</td> <td style="text-align: left;">是</td> <td style="text-align: left;">结构指针</td> <td>OS功能操作集</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_register_recognize_ops(struct vt_bk_handle <em>handle, const _recog_ops_t </em>ops, StatedetParam *dectparams) 【注册识别操作函数和参数】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">ops</td> <td style="text-align: left;">是</td> <td style="text-align: left;">结构指针</td> <td>识别功能操作集，包含识别TASK启动接口和网络请求接口</td> </tr> <tr> <td style="text-align: left;">dectparams</td> <td style="text-align: left;">是</td> <td style="text-align: left;">结构指针</td> <td>翻页算法参数配置</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_start_recognize(struct vt_bk_handle *handle) 【开始绘本识别】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_stop_recognize(struct vt_bk_handle *handle) 【停止识别】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_pause(struct vt_bk_handle *handle) 【暂停识别】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_resume(struct vt_bk_handle *handle) 【恢复识别】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_get_recongstate(struct vt_bk_handle *handle) 【获取识别TASK运行状态】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_register_error_cb(struct vt_bk_handle <em>handle, pfun_vt_error_cb cb, void </em>userp) 【注册识别错误处理】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">cb</td> <td style="text-align: left;">是</td> <td style="text-align: left;">函数指针</td> <td>出错后回调的接口函数</td> </tr> <tr> <td style="text-align: left;">userp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">用户指针</td> <td>用户传入的指针，回调时会带上</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_register_reconginfo_cb(struct vt_bk_handle <em>handle, pfun_vt_recongnize_info_cb cb, void </em>recong_userp) 【注册识别信息回调】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">cb</td> <td style="text-align: left;">是</td> <td style="text-align: left;">函数指针</td> <td>识别回调的接口函数，当resinfo 不为空时当resinfo有效，详细见DEMO</td> </tr> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_select_resource(struct vt_bk_handle *handle, pfun_vt_httpRequest_cb cb, int res_id) 【切换书本播放资源】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">cb</td> <td style="text-align: left;">是</td> <td style="text-align: left;">函数指针</td> <td>切换资源的网络请求函数</td> </tr> <tr> <td style="text-align: left;">res_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>资源库ID,待选择的资源库ID从识别信息回调接口里获取</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong> -int vt_bk_set_params(struct vt_bk_handle *handle, int value) 【设置绘本参数接口，暂未实现】</p> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_get_params(struct vt_bk_handle <em>handle, int </em>value) 【获取绘本参数接口，暂未实现】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：</strong> -int vt_bk_destory(struct vt_bk_handle *handle) 【销毁绘本实例，并释放资源】</p> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p> <p><strong>函数接口名：获取login的信息 openId token等</strong> vt_login_info_t vt_bk_get_login_info(struct vt_bk_handle *handle) 【返回的绘本实例】</p> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> typedef struct vt_login_info { char <em>token; char </em>openId; } vt_login_info_t; 返回0成功，其他失败</p> <p><strong>函数接口名：</strong></p> <ul> <li>int vt_bk_change_resource(struct vt_bk_handle *handle, pfun_vt_httpRequest_cb cb, int res_id) 【切换书本播放另一个资源库的书不改变识别】</li> </ul> <p><strong>参数：</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">handle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">指针</td> <td>绘本句柄</td> </tr> <tr> <td style="text-align: left;">cb</td> <td style="text-align: left;">是</td> <td style="text-align: left;">函数指针</td> <td>切换资源的网络请求函数</td> </tr> <tr> <td style="text-align: left;">res_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>资源库ID,待选择的资源库ID，可从玩瞳后台获取</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> 返回0成功，其他失败</p>