API

客户端包含调用语音服务需要的相关信息，同时也是语音服务调用入口。

实例化

JS SDK 依赖包对外默认导出的就是客户端类，通过 new 关键字可以创建一个客户端实例。使用方法如下。

import NlsClient from 'ali-nls';
// 通过构造函数实例化客户端，options 为创建所需的配置参数
const client = new NlsClient(options);

构造函数通过配置参数来初始化客户端。

constructor(options): NlsClient

options

描述：配置参数
类型：object | 参数 | 类型 | 必须 | 默认值 | 描述 | | —- | —- | —- | —- | —- | | appkey | string | 是 | 无 | 语音应用的 AppKey，可以在管控台中获取 | | accessToken | string
or
function
(): Promise | 是 | 无 | 向 SDK 输入 AccessToken | | server | string | 否 | 公有云地址 | 语音服务网关地址，默认是公有云环境，如果使用专有云环境需要自己配置对应地址 | | deviceId | string | 否 | 自动生成 | 设备 id，可以用来排查问题 | | debug | boolean | 否 | false | 为 true 时会开启控制台日志，可以用来排查问题 |

客户端实例提供的 API，包含主要功能的初始化。

初始化实时语音识别功能。

// 初始化语音识别实例
const instance = clent.initRecognition([options[, plugin]]);

更多配置方式可以参考语音识别的 初始化实例。

初始化合成语音功能。

// 初始化语音合成实例
const instance = clent.initSynthesis([options]);

更多配置方式可以参考语音合成的 初始化实例。

当前环境是否支持 SDK 所有功能正常运行。

isSupport(): boolean

当前环境是否支持 ASR（语音识别）正常运行。

isSupportASR(): boolean

当前环境是否支持 TTS（语音合成）正常运行。

isSupportTTS(): boolean