com.sinovoice.hcicloudsdk.api.hwr

类 HciCloudHwr

java.lang.Object

com.sinovoice.hcicloudsdk.api.hwr.HciCloudHwr

public class HciCloudHwr
extends java.lang.Object

灵云HWR能力API

构造器概要

构造器

构造器和说明
HciCloudHwr()

方法概要

限定符和类型	方法和说明
static int	hciHwrAssociateWords(Session session, java.lang.String assConfig, java.lang.String words, HwrAssociateWordsResult assWordsResult)
static int	hciHwrAssociateWordsAdjust(Session session, java.lang.String assConfig, java.lang.String words) 联想词动态调整，提前pszWord的出现位置
static int	hciHwrConfirm(Session session, java.lang.String confirmResult)
static int	hciHwrInit(java.lang.String initParam) 灵云HWR能力 初始化
static int	hciHwrPenScript(Session session, java.lang.String hwrConfig, int x, int y, HwrPenScriptResult penScriptResult) 获取笔型 传入笔迹点获取笔型位图。
static int	hciHwrPinyin(Session session, java.lang.String hwrConfig, java.lang.String word, HwrPinYinResult pinyinResult) 获取拼音 （仅Windows平台有效，Android无该功能） 传入笔迹点获取笔型位图。
static int	hciHwrRecog(Session session, short[] strokingData, java.lang.String recogConfig, HwrRecogResult outRecogResult)
static int	hciHwrRelease() 灵云HWR能力 反初始化
static int	hciHwrSessionStart(java.lang.String recogConfig, Session outSession) 开始会话
static int	hciHwrSessionStop(Session session) 结束会话

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

HciCloudHwr

public HciCloudHwr()

方法详细资料

hciHwrInit

public static final int hciHwrInit(java.lang.String initParam)

灵云HWR能力 初始化

参数:

initParam - 初始化配置串，可以通过HwrInitParam类辅助生成

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_SYS_NOT_INIT	HCI SYS 尚未初始化
HCI_ERR_HWR_ALREADY_INIT	HWR重复初始化
HCI_ERR_CONFIG_INVALID	配置项非法
HCI_ERR_CONFIG_DATAPATH_MISSING	配置中有initCapkeys却没有dataPath
HCI_ERR_CONFIG_CAPKEY_NOT_MATCH	输入的不是HWR的能力KEY
HCI_ERR_CAPKEY_NOT_FOUND	传入的能力key未找到
HCI_ERR_HWR_ENGINE_INIT_FAILED	本地引擎初始化失败
HCI_ERR_LOCAL_LIB_MISSING	本地引擎缺少字典

hciHwrSessionStart

public static final int hciHwrSessionStart(java.lang.String recogConfig,
                                           Session outSession)

开始会话

参数:

recogConfig - 配置参数串，可以通过HwrConfig类辅助生成

outSession - 成功时返回会话

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_CONFIG_CAPKEY_MISSING	缺少必需的capKey配置项
HCI_ERR_CONFIG_INVALID	配置串中的值不合法
HCI_ERR_CONFIG_CAPKEY_NOT_MATCH	输入的不是HWR的能力KEY
HCI_ERR_CONFIG_UNSUPPORT	不支持传入的配置
HCI_ERR_TOO_MANY_SESSION	创建的Session数量超出限制(256)
HCI_ERR_CAPKEY_NOT_FOUND	传入的能力key未找到
HCI_ERR_URL_MISSING	未找到有效的云服务地址
HCI_ERR_HWR_ENGINE_SESSION_START_FAILED	本地引擎启动会话失败
HCI_ERR_LOCAL_LIB_MISSING	本地引擎缺少字典
HCI_ERR_LOAD_FUNCTION_FROM_DLL	要载入的模块不存在，或者需要的功能在该模块不存在
HCI_ERR_CONFIG_DATAPATH_MISSING	缺少必需的dataPath配置项

hciHwrRecog

public static final int hciHwrRecog(Session session,
                                    short[] strokingData,
                                    java.lang.String recogConfig,
                                    HwrRecogResult outRecogResult)

参数:

session - 会话

strokingData - 要识别的笔迹数据，最大可传入64KB。由若干坐标点组成，每个坐标点形式为（x，y），x 和 y 都是short类型， 有效值是0~32767。有两个分隔符是特例，(-1，0)是一个笔画结束的标记，(-1, -1) 是笔迹结束的标记

recogConfig - 识别配置参数串，可以通过HwrConfig类辅助生成

outRecogResult - 输出的手写识别的结果对象

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_DATA_SIZE_TOO_LARGE	传入的点数超过可处理的上限
HCI_ERR_CONFIG_INVALID	配置串中的值不合法
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_SYS_NOT_INIT	HCI SYS未初始化
HCI_ERR_CAPKEY_NOT_FOUND	传入的能力key未找到
HCI_ERR_CONFIG_UNSUPPORT	不支持传入的配置
HCI_ERR_HWR_ENGINE_FAILED	本地引擎识别失败(引擎返回结果为空也被认为是失败)
HCI_ERR_URL_MISSING	未找到有效的云服务地址
HCI_ERR_SERVICE_CONNECT_FAILED	连接服务器失败，服务器无响应
HCI_ERR_SERVICE_TIMEOUT	服务器访问超时
HCI_ERR_SERVICE_DATA_INVALID	服务器返回的数据格式不正确
HCI_ERR_SERVICE_RESPONSE_FAILED	服务器返回识别失败
HCI_ERR_UNSUPPORT	暂不支持
HCI_ERR_HWR_CONFIG_SUBLANG_MISSING	多语种能力时未传入subLang配置

hciHwrConfirm

public static final int hciHwrConfirm(Session session,
                                      java.lang.String confirmResult)

参数:

session - 会话

confirmResult - 要提交的确认结果,UTF8格式，以’\0‘结束，不能超过2048字节（包括’\0’）

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_DATA_SIZE_TOO_LARGE	传入的确认文本超过可处理的上限
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_HWR_CONFIRM_NO_TASK	没有可用来提交的任务，例如尚未识别就调用了本函数
HCI_ERR_SERVICE_CONNECT_FAILED	连接服务器失败，服务器无响应
HCI_ERR_SERVICE_TIMEOUT	服务器访问超时
HCI_ERR_SERVICE_DATA_INVALID	服务器返回的数据格式不正确
HCI_ERR_UNSUPPORT	暂不支持
HCI_ERR_SERVICE_RESPONSE_FAILED	服务器返回识别失败

hciHwrAssociateWords

public static final int hciHwrAssociateWords(Session session,
                                             java.lang.String assConfig,
                                             java.lang.String words,
                                             HwrAssociateWordsResult assWordsResult)

参数:

session - 会话

assConfig - 联想配置参数串，可以通过HwrConfig类辅助生成

words - 进行联想的字

assWordsResult - 输出的联想结果对象

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_HWR_ENGINE_FAILED	本地引擎获取联想词失败
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_CONFIG_INVALID	配置串中的值不合法
HCI_ERR_UNSUPPORT	暂不支持
HCI_ERR_LOAD_FUNCTION_FROM_DLL	要载入的模块不存在，或者需要的功能在该模块不存在

hciHwrAssociateWordsAdjust

public static final int hciHwrAssociateWordsAdjust(Session session,
                                                   java.lang.String assConfig,
                                                   java.lang.String words)

联想词动态调整，提前pszWord的出现位置

参数:

session - 会话

assConfig - 联想配置参数串，可以通过HwrConfig类辅助生成

words - 字符串，UTF-8格式，以’\0’为结束符，最少2个字符，最多15个字符(注意：不是15个字节)。

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_DATA_SIZE_TOO_LARGE	传入的文本超过15个字符
HCI_ERR_HWR_ENGINE_FAILED	联想词动态调整失败
HCI_ERR_UNSUPPORT	暂不支持
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_LOAD_FUNCTION_FROM_DLL	要载入的模块不存在，或者需要的功能在该模块不存在

hciHwrSessionStop

public static final int hciHwrSessionStop(Session session)

结束会话

参数:

session - 会话

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_SESSION_INVALID	传入的Session非法

hciHwrPenScript

public static final int hciHwrPenScript(Session session,
                                        java.lang.String hwrConfig,
                                        int x,
                                        int y,
                                        HwrPenScriptResult penScriptResult)

获取笔型 传入笔迹点获取笔型位图。 此函数会根据前后两次传入的点的位置关系进行位图的生成，如果此次传入的坐标点是第一个传入的坐标点，或者与之前传入的坐标点 完全相同则不会生成位图结果。 每一笔结束的时候要传入(-1,0),结束本次笔型生成。 此函数的配置项只在两种情况下生效：(1)第一次调用此函数；(2)传入结束笔迹标记(-1,0)后下一次调用此函数。

参数:

session - 会话

hwrConfig - 识别参数配置串,ASCII字符串，以’\0’结束，可为NULL

x - 笔迹点的横坐标 取值>= 0或者 -1

y - 笔迹点的纵坐标取值 >= 0

psPenScript - 返回的笔型结果对象

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_CONFIG_INVALID	配置串中的值不合法
HCI_ERR_HWR_ENGINE_INIT_FAILED	初始化笔形库失败
HCI_ERR_HWR_ENGINE_FAILED	本地引擎获取笔型失败
HCI_ERR_LOAD_FUNCTION_FROM_DLL	要载入的模块不存在，或者需要的功能在该模块不存在

hciHwrPinyin

public static final int hciHwrPinyin(Session session,
                                     java.lang.String hwrConfig,
                                     java.lang.String word,
                                     HwrPinYinResult pinyinResult)

获取拼音 （仅Windows平台有效，Android无该功能） 传入笔迹点获取笔型位图。 此函数会根据前后两次传入的点的位置关系进行位图的生成，如果此次传入的坐标点是第一个传入的坐标点，或者与之前传入的坐标点 完全相同则不会生成位图结果。 每一笔结束的时候要传入(-1,0),结束本次笔型生成。 此函数的配置项只在两种情况下生效：(1)第一次调用此函数；(2)传入结束笔迹标记(-1,0)后下一次调用此函数。

参数:

session - 会话

hwrConfig - 获取拼音配置串,ASCII字符串，以’\0’结束

word - 字符串指针，UTF-8格式，字符串以’\0’结束。如果多于一个汉字，只返回第一个汉字的拼音结果

pinyinResult - 输出的拼音结果对象（如果为多音字，则会有多个结果，否则只有一个结果）

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_PARAM_INVALID	传入的参数不合法
HCI_ERR_LOCAL_LIB_MISSING	本地拼音字典丢失
HCI_ERR_HWR_ENGINE_INIT_FAILED	本地引擎初始化失败
HCI_ERR_HWR_ENGINE_FAILED	本地引擎获取拼音失败
HCI_ERR_LOAD_FUNCTION_FROM_DLL	要载入的模块不存在，或者需要的功能在该模块不存在

hciHwrRelease

public static final int hciHwrRelease()

灵云HWR能力 反初始化

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_HWR_NOT_INIT	HCI HWR尚未初始化
HCI_ERR_ACTIVE_SESSION_EXIST	尚有未stop的Sesssion，无法结束