AppleReader

立即使用

概述

模块概述

本模块封装了苹果语音播报功能。通过initReader接口可初始化一个语音播报器,同时获取其支持的最大和最小语速。getReader接口可以获取语音播报器支持的语言和当前语音,如zh-CH。开发者可通过config接口配置播报器的语速、音量、音高以及停顿时间和语言等参数。start、pause、stop、continue可对语音播报器进行开始、暂停、停止、继续操作。addEventListener接口可监听语音播报的开始、完成、暂停等事件。

模块接口

initReader

初始化语音播报器

initReader({params},callback(ret, err))

params

content:

  • 类型:字符串
  • 描述:要朗读的文字

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否成功
    maxSpeechRate:,   //数字类型;支持的最大语速
    minSpeechRate:    //数字类型;支持的最小语速
}

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.initReader({
     content:'柚子(北京)科技有限公司于2014-01-03在海淀分局登记成立。法定代表人刘鑫,公司经营范围包括技术开发、技术推广、技术转让、技术咨询;销售通讯设备等。'
},function(ret) {
     api.alert({msg:JSON.stringify(ret)});
});

可用性

iOS 系统

可提供的 1.0.0 及更高版本

getReader

获取朗读器信息

getReader(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    currentLanguageCode:'',     //字符串类型;当前语言
    supportLanguageCode:[]      //数组类型;支持的语言
}

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.getReader(function(ret) {
    api.alert({msg:JSON.stringify(ret)});
});

可用性

iOS 系统

可提供的 1.0.0 及更高版本

config

配置朗读器参数

config({params},callback())

params

speechRate:

  • 类型:数字
  • 描述:(可选项)朗读的语速
  • 默认:0.5

pitchMultiplier:

  • 类型:数字
  • 描述:(可选项)朗读的音高,取值范围:0.5-2
  • 默认:1

volume:

  • 类型:数字
  • 描述:(可选项)朗读的音量,取值范围:0-1
  • 默认:1

preUtteranceDelay:

  • 类型:数字
  • 描述:(可选项)朗读的前停顿时间,单位秒
  • 默认:1

postUtteranceDelay:

  • 类型:数字
  • 描述:(可选项)朗读的后停顿时间,单位秒
  • 默认:1

languageCode:

  • 类型:字符串
  • 描述:(可选项)朗读的语言
  • 默认:zh-CN

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.config({
    speechRate:,
    pitchMultiplier:,
    volume:,
    preUtteranceDelay:,
    postUtteranceDelay:,
    languageCode:'zh-CN'
});

可用性

iOS 系统

可提供的 1.0.0 及更高版本

start

开始朗读

start()

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.start();

可用性

iOS 系统

可提供的 1.0.0 及更高版本

pause

暂停朗读

pause()

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.pause();

可用性

iOS 系统

可提供的 1.0.0 及更高版本

continue

继续朗读

continue()

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.continue();

可用性

iOS 系统

可提供的 1.0.0 及更高版本

stop

停止朗读

stop()

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.stop();

可用性

iOS 系统

可提供的 1.0.0 及更高版本

addEventListener

添加加监听

addEventListener({params},callback(ret, err))

params

target:

  • 类型:字符串
  • 描述:监听的事件名
  • 取值范围:
    • didStart:开始
    • didFinish:完成
    • didPause:暂停
    • didContinue:继续
    • didCancel:取消停止

callback(ret)

ret:

  • 内部字段: 无参数,仅有事件返回

示例代码

var AppleReader = api.require('AppleReader');
AppleReader.addEventListener(function(ret) {
     api.alert({msg:JSON.stringify(ret)});
});

可用性

iOS 系统

可提供的 1.0.0 及更高版本