SDK文档
<h3>概述</h3>
<p>该部分接口的入口类为 <strong>LabelDataMgr</strong>，在调用该部分接口前，需要打开sdk和license认证通过，否则有可能会导致部分功能无法正常work。</p>
<h3>1.初始化SDK</h3>
<p><strong>接口名称：</strong></p>
<pre><code class="language-java">public LabelDataMgr init()</code></pre>
<p><strong>备注：</strong></p>
<h3>2.设置接口回调</h3>
<pre><code class="language-java">public LabelDataMgr setILabelDataCallback(ILabelDataCallback callback)</code></pre>
<h4>2.1 ILabelDataCallback介绍</h4>
<p>ILabelDataCallback是数据结果的返回，有三个方法onLabelSuccess， onWordInfoCallback和onLabelFail;</p>
<p><strong>方法名称：</strong></p>
<pre><code class="language-java"> /**
* 书页标签请求失败，目录信息返回失败
* @param code 错误码
* @param msg 错误信息
*/
void onLabelFail(int code, String msg);
/**
* 书页标签数据返回成功
* @param labelDataBean 数据返回结构数据bean
*/
void onLabelSuccess(LabelDataBean labelDataBean);
</code></pre>
<h4>2.2 onLabelSuccess回调的LabelDataBean介绍</h4>
<pre><code class="language-java"> /**
* 资源库的bookId
*/
private int bookId;
/**
* 资源库的pageId
*/
private int pageId;
/**
* 资源库的安全bookId
*/
private String securityId;
/**
* &quot;labelType&quot;: 16, ////框标签
* （1课文标题 2大标题 3小标题 4课文正文 5练习 6页码；7段落 8生字-会认 9生字-会写 10词语 11古诗词；12单词 13句子 14歌曲；15课文例题 16公式定理）
*/
private LabelInfo textTitleLabel;//1课文标题
private LabelInfo headlineLabel;//2大标题
private LabelInfo subheadLabel;//3小标题
private LabelInfo textContentLabel;//4课文正文
private LabelInfo exerciseLabel;//5练习
private LabelInfo pageNumberLabel;//6页码
private LabelInfo paragraphLabel;//7段落
private LabelInfo knowWordChLabel;//8生字-会认
private LabelInfo writeWordChLabel;//9生字-会写
private LabelInfo wordsChLabel;//10词语
private LabelInfo ancientPoetryLabel;//11古诗词
private LabelInfo wordEnLabel;//12单词
private LabelInfo sentenceLabel;//13句子
private LabelInfo songLabel;//14歌曲
private LabelInfo sampleQuestionLabel;//15课文例题
private LabelInfo formulaTheoremLabel;//16公式定理
private LabelInfo pinyinLabel;//17拼音
private LabelInfo commentLabel;//18注释
private LabelInfo readLabel;//19阅读
private LabelInfo keySentenceLabel;//20重点句
private LabelInfo standbyOneLabel;//21备用1
private LabelInfo standbyTwoLabel;//22备用2
/**
* 目录相关的信息
*/
private List&lt;DirInfoBean&gt; dirInfos;
</code></pre>
<h4>2.2.1 LabelDataBean返回结果</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>bookId</td>
<td>是</td>
<td>int</td>
<td>资源库的bookId</td>
</tr>
<tr>
<td>pageId</td>
<td>是</td>
<td>int</td>
<td>资源库的pageId</td>
</tr>
<tr>
<td>textTitleLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>课文标题</td>
</tr>
<tr>
<td>headlineLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>大标题</td>
</tr>
<tr>
<td>subheadLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>小标题</td>
</tr>
<tr>
<td>textContentLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>课文正文</td>
</tr>
<tr>
<td>exerciseLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>练习</td>
</tr>
<tr>
<td>pageNumberLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>页码</td>
</tr>
<tr>
<td>paragraphLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>段落</td>
</tr>
<tr>
<td>knowWordChLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>生字-会认</td>
</tr>
<tr>
<td>writeWordChLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>生字-会写</td>
</tr>
<tr>
<td>wordsChLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>词语</td>
</tr>
<tr>
<td>ancientPoetryLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>古诗词</td>
</tr>
<tr>
<td>wordEnLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>单词</td>
</tr>
<tr>
<td>sentenceLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>句子</td>
</tr>
<tr>
<td>songLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>歌曲</td>
</tr>
<tr>
<td>sampleQuestionLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>课文例题</td>
</tr>
<tr>
<td>formulaTheoremLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>公式定理</td>
</tr>
<tr>
<td>pinyinLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>拼音</td>
</tr>
<tr>
<td>commentLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>注释</td>
</tr>
<tr>
<td>readLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>阅读</td>
</tr>
<tr>
<td>keySentenceLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>重点句</td>
</tr>
<tr>
<td>standbyOneLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>备用1</td>
</tr>
<tr>
<td>standbyTwoLabel</td>
<td>是</td>
<td>LabelInfo/object</td>
<td>备用2</td>
</tr>
<tr>
<td>dirInfos</td>
<td>是</td>
<td>List<DirInfoBean></td>
<td>目录相关的信息</td>
</tr>
</tbody>
</table>
<h3>LabelDataBean.LabelInfo:</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>labelType</td>
<td>是</td>
<td>int</td>
<td>框标签（1课文标题 2大标题 3小标题 4课文正文 5练习 6页码；7段落 8生字-会认 9生字-会写 10词语 11古诗词；12单词 13句子 14歌曲；15课文例题 16公式定理）</td>
</tr>
<tr>
<td>frames</td>
<td>是</td>
<td>List<FramesData></td>
<td>框数据</td>
</tr>
</tbody>
</table>
<h5>LabelDataBean.LabelInfo.FramesData:</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>frameId</td>
<td>是</td>
<td>int</td>
<td>框id</td>
</tr>
<tr>
<td>extraData</td>
<td>是</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>evalText</td>
<td>是</td>
<td>String</td>
<td>框文本 ---> 段落：OCR识别结果</td>
</tr>
<tr>
<td>pinyin</td>
<td>是</td>
<td>String</td>
<td>拼音</td>
</tr>
<tr>
<td>explain</td>
<td>是</td>
<td>String</td>
<td>释义</td>
</tr>
<tr>
<td>audios</td>
<td>是</td>
<td>AudiosBean/object</td>
<td>框文本语音 ---> 段落：OCR识别结果音频</td>
</tr>
<tr>
<td>explainAudios</td>
<td>是</td>
<td>List<ExplainAudiosBean></td>
<td>讲解内容 ---> 段落：讲解搜索结果</td>
</tr>
<tr>
<td>labelTypes</td>
<td>是</td>
<td>List<Integer></td>
<td>框标签</td>
</tr>
<tr>
<td>securityQuestIds</td>
<td>是</td>
<td>List<FramesData></td>
<td>习题安全id列表</td>
</tr>
<tr>
<td>questId</td>
<td>是</td>
<td>long</td>
<td>习题id</td>
</tr>
<tr>
<td>phrases</td>
<td>是</td>
<td>List<PhraseBean></td>
<td>固定搭配</td>
</tr>
</tbody>
</table>
<h5>LabelDataBean.LabelInfo.FramesData.AudiosBean:</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>voice</td>
<td>是</td>
<td>List<VoiceBean></td>
<td>框文本语音</td>
</tr>
<tr>
<td>bgMusic</td>
<td>是</td>
<td>List<VoiceBean></td>
<td>背景音乐</td>
</tr>
<tr>
<td>effectSound</td>
<td>是</td>
<td>List<VoiceBean></td>
<td>音效</td>
</tr>
</tbody>
</table>
<h5>LabelDataBean.LabelInfo.FramesData.AudiosBean.VoiceBean:</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>fileName</td>
<td>是</td>
<td>String</td>
<td>音频地址url</td>
</tr>
<tr>
<td>clientFileName</td>
<td>是</td>
<td>String</td>
<td>音频文件名(暂未使用)</td>
</tr>
<tr>
<td>loop</td>
<td>是</td>
<td>int</td>
<td>是否循环(暂未使用)</td>
</tr>
<tr>
<td>startAt</td>
<td>是</td>
<td>float</td>
<td>开始位置(暂未使用)</td>
</tr>
</tbody>
</table>
<h5>LabelDataBean.LabelInfo.FramesData.ExplainAudiosBean:</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>是</td>
<td>String</td>
<td>讲解文本</td>
</tr>
<tr>
<td>frameId</td>
<td>是</td>
<td>int</td>
<td>框id</td>
</tr>
<tr>
<td>fileName</td>
<td>是</td>
<td>String</td>
<td>讲解音频</td>
</tr>
<tr>
<td>clientFileName</td>
<td>是</td>
<td>String</td>
<td>音频文件名(暂未使用)</td>
</tr>
<tr>
<td>loop</td>
<td>是</td>
<td>int</td>
<td>是否循环(暂未使用)</td>
</tr>
<tr>
<td>startAt</td>
<td>是</td>
<td>float</td>
<td>开始位置(暂未使用)</td>
</tr>
</tbody>
</table>
<h5>LabelDataBean.LabelInfo.FramesData.PhraseBean:</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>word</td>
<td>是</td>
<td>String</td>
<td>词</td>
</tr>
<tr>
<td>meaning</td>
<td>是</td>
<td>String</td>
<td>释义</td>
</tr>
</tbody>
</table>
<h3>LabelDataBean.DirInfoBean:</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>是</td>
<td>String</td>
<td>目录id</td>
</tr>
<tr>
<td>name</td>
<td>是</td>
<td>String</td>
<td>目录名称</td>
</tr>
<tr>
<td>dirMap</td>
<td>是</td>
<td>HashMap<Integer, List<Long>></td>
<td>目录id映射,只能读取key为4的values</td>
</tr>
</tbody>
</table>
<h3>3. 获取书页标签数据方法</h3>
<pre><code class="language-java"> public void getPageLabelData(int bookId, int pageId, String securityId)</code></pre>
<h4>3.1 参数类型</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>bookId</td>
<td>是</td>
<td>int</td>
<td>资源库的bookId</td>
</tr>
<tr>
<td>pageId</td>
<td>是</td>
<td>int</td>
<td>资源库的pageId</td>
</tr>
<tr>
<td>securityId</td>
<td>是</td>
<td>String</td>
<td>资源库的安全bookId</td>
</tr>
</tbody>
</table>
<pre><code class="language-java"> public class LabelInfoDataBean {
private int pageId;
private List&lt;DirInfoBean&gt; dirs;
private List&lt;LabelsBean&gt; labels;
}</code></pre>
<h4>3.2 LabelInfoDataBean 返回结果</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>pageId</td>
<td>是</td>
<td>int</td>
<td>书本的页码id</td>
</tr>
<tr>
<td>dirs</td>
<td>是</td>
<td>List<DirInfoBean></td>
<td>目录信息【参照上面的LabelDataBean.DirInfoBean】</td>
</tr>
<tr>
<td>labels</td>
<td>是</td>
<td>List<LabelsBean></td>
<td>标签信息</td>
</tr>
</tbody>
</table>
<h4>LabelInfoDataBean.LabelsBean:</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>labelType</td>
<td>是</td>
<td>int</td>
<td>框标签（1课文标题 2大标题 3小标题 4课文正文 5练习 6页码；7段落 8生字-会认 9生字-会写 10词语 11古诗词；12单词 13句子 14歌曲；15课文例题 16公式定理）</td>
</tr>
<tr>
<td>frames</td>
<td>是</td>
<td>List<FramesData></td>
<td>框数据</td>
</tr>
</tbody>
</table>
<h5>LabelInfoDataBean.LabelsBean.FramesData:</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>frameId</td>
<td>是</td>
<td>int</td>
<td>框id</td>
</tr>
<tr>
<td>extraData</td>
<td>是</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>evalText</td>
<td>是</td>
<td>String</td>
<td>框文本 ---> 段落：OCR识别结果</td>
</tr>
<tr>
<td>videoText</td>
<td>是</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>audios</td>
<td>是</td>
<td>AudiosBean/object</td>
<td>框文本语音 ---> 段落：OCR识别结果音频 【参照上面的LabelDataBean.LabelInfo.FramesData.AudiosBean】</td>
</tr>
<tr>
<td>position</td>
<td>是</td>
<td>PositionBean/object</td>
<td>框信息</td>
</tr>
<tr>
<td>texts</td>
<td>是</td>
<td>Object</td>
<td>框信息</td>
</tr>
<tr>
<td>fingerTexts</td>
<td>是</td>
<td>Object</td>
<td>框信息</td>
</tr>
<tr>
<td>evalTexts</td>
<td>是</td>
<td>List<Object></td>
<td>评测文本</td>
</tr>
<tr>
<td>explainAudios</td>
<td>是</td>
<td>List<ExplainAudiosBean></td>
<td>讲解内容 ---> 段落：讲解搜索结果 【参照上面的LabelDataBean.LabelInfo.FramesData.ExplainAudiosBean】</td>
</tr>
<tr>
<td>labelTypes</td>
<td>是</td>
<td>List<Integer></td>
<td>框标签</td>
</tr>
<tr>
<td>securityQuestIds</td>
<td>是</td>
<td>List<String></td>
<td>习题安全id列表</td>
</tr>
</tbody>
</table>
<h4>LabelInfoDataBean.LabelsBean.FramesData.PositionBean:</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>shapeType</td>
<td>是</td>
<td>int</td>
<td></td>
</tr>
<tr>
<td>strokeStyle</td>
<td>是</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>name</td>
<td>是</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>chosenCode</td>
<td>是</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td>nickName</td>
<td>是</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>shape</td>
<td>是</td>
<td>List<ShapeBean></td>
<td>坐标</td>
</tr>
</tbody>
</table>
<h4>LabelInfoDataBean.LabelsBean.FramesData.PositionBean.ShapeBean:</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>x</td>
<td>是</td>
<td>int</td>
<td>X轴坐标</td>
</tr>
<tr>
<td>y</td>
<td>是</td>
<td>int</td>
<td>Y轴坐标</td>
</tr>
</tbody>
</table>
<h3>4. 释放</h3>
<p><strong>接口名称：</strong></p>
<pre><code class="language-java">//注销
public void onExit();</code></pre>