SDK说明

SDK引用

SDK功能注册到了window.yiyu.app对象中，如果使用es6模块引入，SDK功能注册到了yiyu模块内。

window.yiyu.app.init({name:'需要登录的账号'})

// es6模块导入
yiyu.init({name:'需要登录的账号'})

SDK调用

除了事件监听方法之外，其他方法必须在调用init方法并成功加载出数字人之后再调用

方法列表

初始化

yiyu.app.init

首次初始化数字人调用的方法，调用init方法之后将验证登录的账号，验证成功后会初始化配置并加载数字人。

参数

属性	类型	必填	默认值	说明
name	string	是		登录账号名，可在控制台获取
modelName	string	否		初始化时加载时账号下数字人资产列表的指定数字人，默认加载数字人资产列表第一个数字人
readLocalResource	boolean	否	true	读取本地手语资源，为flase读取服务器资源
showToast	boolean	否	false	初始化时打出你好手语并显示弹出Toast划词提示
draggable	boolean	否	true	数字人拖动

示例

<script>
    window.addEventListener('load', function () {
        yiyu.app.init({name:'需要登录的账号'})
    })
</script>

// es6
yiyu.init({name:'需要登录的账号'})

手语翻译

yiyu.app.startTranslate

开始手语翻译。

1、调用后会数字人会使用手语表示输入文本，如果当前正在手语翻译过程中，会停止当前翻译。

2、输入text最大长度为450字，输入超过限制字数时将截取前450字。

3、该接口同一个客户端在2秒内只能调用一次。

参数

属性	类型	默认值	必填	说明
text	string	' '	是	需要翻译的文本，一次翻译最大字数450字

示例

<script>
    let txt = '欢迎使用果不其然手语数字人SDK'
    yiyu.app.startTranslate(txt);
</script>

yiyu.app.appendTranslation

追加手语翻译内容。

1、调用后会将当前输入存储到待翻译队列中，不会停下当前进行的手语翻译，如果当前没有进行手语翻译，等价于yiyu.app.startTranslate。

2、输入text最大长度为450字，输入超过限制字数时将截取前450字。

3、该接口同一个客户端在500ms内只能调用一次。

参数

属性	类型	默认值	必填	说明
text	string	' '	是	需要翻译的文本，一次翻译最大字数450字

示例

<script>
    let txt = '欢迎使用果不其然手语数字人SDK'
    yiyu.app.appendTranslation(txt);
</script>

yiyu.app.cancelTranslation

取消手语翻译。调用后会停止手语翻译，并清除待翻译队列。

示例

<script>
    yiyu.app.cancelTranslation();
</script>

yiyu.app.modifyPlaySpeed

设置手语翻译速度。调用后会变更手语翻译速度

参数

属性	类型	默认值	范围	必填	说明
speed	number	1.5	1.0~3.0	是	手语速度值，精确到小数点后1位

示例

<script>
    yiyu.app.modifyPlaySpeed(2.0);
</script>

功能控制

yiyu.app.enableHyperTranslation

打开鼠标点读功能。鼠标移动到链接上会读出链接内容。

参数

属性	类型	默认值	范围	必填	说明
hoverInterval	number	400	0~2000	否	鼠标在超链接上悬停hoverInterval毫秒后对内容进行手语翻译

示例

<script>
    yiyu.app.enableHyperTranslation(400)
</script>

yiyu.app.disableHyperTranslation

关闭鼠标点读功能。鼠标移动到链接上不会读出链接内容。

示例

<script>
    yiyu.app.disableHyperTranslation()
</script>

yiyu.app.enableTextSelection

打开划词功能。鼠标划词会读出划词内容。

示例

<script>
    yiyu.app.enableTextSelection()
</script>

yiyu.app.disableTextSelection

关闭划词功能。鼠标划词不会读出划词内容。

示例

<script>
    yiyu.app.disableTextSelection()
</script>

yiyu.app.enableYiyuApp

打开应用。调用后会显示手语数字人，划词功能和鼠标点读功能会同时打开。

示例

<script>
    yiyu.app.enableYiyuApp()
</script>

yiyu.app.disableYiyuApp

关闭应用。调用后会隐藏手语数字人，划词功能和鼠标点读功能会同时关闭。

示例

<script>
    yiyu.app.disableYiyuApp()
</script>

yiyu.app.reloadModel

切换数字人。

1、若账户下有多个数字人资产，在数字人运行时可使用reloadModel方法切换指定的数字人。 2、如需在初始化时指定数字人，可参考init方法

参数

参数	类型	默认值	范围	必填	说明
'数字人名称或代号'	string			否	默认加载数字人资产列表第一个数字人

示例

<script>
    yiyu.app.reloadModel('1014_01')
</script>

yiyu.app.toast

toast弹窗。

参数

属性	类型	默认值	范围	必填	说明
message	string			是	内容
time	number	1500		是	显示毫秒数

示例

<script>
    yiyu.app.toast({message:"你好"，time:1500})
</script>

界面控制

yiyu.app.setSize

设置手语数字人窗口大小。调用后会设置手语数字人窗口大小。

参数

属性	类型	默认值	范围	必填	说明
width	number	300		是	手语数字人窗口宽度，整数或百分比字符串，整数单位为px
height	number	300		是	手语数字人窗口高度，整数或百分比字符串，整数单位为px

示例

<script>
    yiyu.app.setSize(400, 400)
</script>

yiyu.app.setAvatarSize

设置手语数字人大小。调用后会设置手语数字人大小（不改变窗口尺寸）。

参数

属性	类型	默认值	范围	必填	说明
size	number	1	1~7	是	数字人大小等级，数字越大数字人越小

示例

<script>
    yiyu.app.setAvatarSize(4)
</script>

yiyu.app.setPosition

设置手语数字人窗口位置。调用后会设置手语数字人窗口位置。

参数

属性	类型	默认值	范围	必填	说明
top	number	0		是	窗口位置top，整数或百分比字符串，整数单位为px
left	number	0		是	窗口位置left，整数或百分比字符串，整数单位为px

示例

<script>
    yiyu.app.setPosition(500,500)
</script>

事件监听

yiyu.app.onHtmlReady

监听js资源加载完成事件。这一事件仅代表yiyu.js所需要的核心js文件已加载完毕。

参数

属性	类型	默认值	范围	必填	说明
callback	function				callback是无参回调方法，事件触发后会调用所有传入的callback

示例

<script>
    yiyu.app.onHtmlReady(function(){
        console.log('数字人页面加载完成')
    })
</script>

yiyu.app.onAppReady

监听数字人加载完成事件。这一事件代表调用init方法登陆成功之后开始加载数字人，数字人加载完成之后的回调，可以进行手语翻译或其他api调用。

参数

属性	类型	默认值	范围	必填	说明
callback	function			是	callback是无参回调方法，事件触发后会调用所有传入的callback

示例

<script>
    yiyu.app.onAppReady(function(){
        console.log('数字人应用加载完成')
    })
</script>

yiyu.app.onSingleSignFinished

监听单次手语动作完成事件。这一事件代表数字人每打完一个手语时触发这一事件。

参数

属性	类型	默认值	范围	必填	说明
callback	function	无		是	callback是无参方法，事件触发后会调用所有传入的callback

示例

<script>
    yiyu.app.onSingleSignFinished(function(){
        console.log('单次手语动作完成')
    })
</script>

yiyu.app.onSentenceFinished

监听手语翻译完成事件。这一事件代表数字人打完所有手语时触发这一事件。

参数

属性	类型	默认值	范围	必填	说明
callback	function			是	callback是无参方法，事件触发后会调用所有传入的callback

示例

<script>
    yiyu.app.onSentenceFinished(function(){
        console.log('手语翻译完成')
    })
</script>