README
¶
NLS Go SDK 说明
本文介绍如何使用阿里云智能语音服务提供的 Go SDK，包括 SDK 的安装方法及 SDK 代码示例。
前提条件
使用 SDK 前，请先阅读接口说明，详细请参见接口说明。
下载安装
说明
- SDK 支持 go1.16
- 请确认已经安装 golang 环境，并完成基本配置
- 下载 SDK
通过以下命令完成 SDK 下载和安装：
go get github.com/ikmak/alibabacloud-nls-go-sdk
- 导入 SDK
在代码中通过将以下字段加入 import 来导入 SDK：
import ("github.com/ikmak/alibabacloud-nls-go-sdk")
SDK 常量
| 常量 | 常量含义 |
|---|---|
| SDK_VERSION | SDK 版本 |
| PCM | pcm 音频格式 |
| WAV | wav 音频格式 |
| OPUS | opus 音频格式 |
| OPU | opu 音频格式 |
| DEFAULT_DISTRIBUTE | 获取 token 时使用的默认区域，"cn-shanghai" |
| DEFAULT_DOMAIN | 获取 token 时使用的默认 URL，"nls-meta.cn-shanghai.aliyuncs.com" |
| DEFAULT_VERSION | 获取 token 时使用的协议版本，"2019-02-28" |
| DEFAULT_URL | 默认公有云 URL，"wss://nls-gateway.cn-shanghai.aliyuncs.com/ws/v1" |
SDK 日志
1. func DefaultNlsLog() *NlsLogger
用于创建全局唯一的默认日志对象，默认日志以 NLS 为前缀，输出到标准错误
参数说明：
无
返回值：
NlsLogger 对象指针
2. func NewNlsLogger(w io.Writer, tag string, flag int) *NlsLogger
创建一个新的日志
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| w | io.Writer | 任意实现 io.Writer 接口的对象 |
| tag | string | 日志前缀，会打印到日志行首部 |
| flag | int | 日志 flag，具体参考 go 官方 log 文档 |
返回值：
NlsLogger 对象指针
3. func (logger *NlsLogger) SetLogSil(sil bool)
设置日志是否输出到对应的 io.Writer
参数说明:
| 参数 | 类型 | 参数说明 |
|---|---|---|
| sil | bool | 是否禁止日志输出，true 为禁止 |
返回值：
无
4. func (logger *NlsLogger) SetDebug(debug bool)
设置是否打印 debug 日志，仅影响通过 Debugf 或 Debugln 进行输出的日志
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| debug | bool | 是否允许 debug 日志输出，true 为允许 |
返回值：
无
5. func (logger *NlsLogger) SetOutput(w io.Writer)
设置日志输出方式
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| w | io.Writer | 任意实现 io.Writer 接口的对象 |
返回值：
无
6. func (logger *NlsLogger) SetPrefix(prefix string)
设置日志行的标签
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| prefix | string | 日志行标签，会输出在日志行行首 |
返回值：
无
7. func (logger *NlsLogger) SetFlags(flags int)
设置日志属性
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| flags | int | 日志属性，见https://pkg.go.dev/log#pkg-constants |
返回值：
无
8. 日志打印
日志打印方法：
| 方法名 | 方法说明 |
|---|---|
| func (l *NlsLogger) Print(v ...interface{}) | 标准日志输出 |
| func (l *NlsLogger) Println(v ...interface{}) | 标注日志输出，行尾自动换行 |
| func (l *NlsLogger) Printf(format string, v ...interface{}) | 带 format 的日志输出，format 方式见 go 官方文档 |
| func (l *NlsLogger) Debugln(v ...interface{}) | debug 信息日志输出，行尾自动换行 |
| func (l *NlsLogger) Debugf(format string, v ...interface{}) | 带 format 的 debug 信息日志输出 |
| func (l *NlsLogger) Fatal(v ...interface{}) | 致命错误日志输出，输出后自动进程退出 |
| func (l *NlsLogger) Fatalln(v ...interface{}) | 致命错误日志输出，行尾自动换行，输出后自动进程退出 |
| func (l *NlsLogger) Fatalf(format string, v ...interface{}) | 带 format 的致命错误日志输出，输出后自动进程退出 |
| func (l *NlsLogger) Panic(v ...interface{}) | 致命错误日志输出，输出后自动进程退出并打印崩溃信息 |
| func (l *NlsLogger) Panicln(v ...interface{}) | 致命错误日志输出，行尾自动换行，输出后自动进程退出并打印崩溃信息 |
| func (l *NlsLogger) Panicf(format string, v ...interface{}) | 带 format 的致命错误日志输出，输出后自动进程退出并打印崩溃信息 |
获取 token
1. func GetToken(dist string, domain string, akid string, akkey string, version string) (*TokenResultMessage, error)
获取访问 token
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| dist | string | 区域，如果不确定，请使用 DEFAULT_DISTRIBUTE |
| domain | string | URL，如果不确定，请使用 DEFAULT_DOMAIN |
| akid | string | 阿里云 accessid |
| akkey | string | 阿里云 accesskey |
| version | string | 协议版本，如果不确定，请使用 DEFAULT_VERSION |
返回值：
TokenResultMessage 对象指针和错误信息
建立连接
1. ConnectionConfig
用于建立连接的基础参数
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| Url | string | 访问的公有云 URL，如果不确定，可以使用 DEFAULT_URL |
| Token | string | 通过 GetToken 获取的 token 或者测试 token |
| Akid | string | 阿里云 accessid |
| Akkey | string | 阿里云 accesskey |
| Appkey | string | appkey，可以在控制台中对应项目上看到 |
2. func NewConnectionConfigWithAKInfoDefault(url string, appkey string, akid string, akkey string) (*ConnectionConfig, error)
通过 url，appkey，akid 和 akkey 创建连接参数，等效于先调用 GetToken 然后再调用 NewConnectionConfigWithToken
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| Url | string | 访问的公有云 URL，如果不确定，可以使用 DEFAULT_URL |
| Appkey | string | appkey，可以在控制台中对应项目上看到 |
| Akid | string | 阿里云 accessid |
| Akkey | string | 阿里云 accesskey |
返回值：
*ConnectionConfig：连接参数对象指针，用于后续创建语音交互实例
error：异常对象，为 nil 则无异常
3. func NewConnectionConfigWithToken(url string, appkey string, token string) *ConnectionConfig
通过 url，appkey 和 token 创建连接参数
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| Url | string | 访问的公有云 URL，如果不确定，可以使用 DEFAULT_URL |
| Appkey | string | appkey，可以在控制台中对应项目上看到 |
| Token | string | 已经通过 GetToken 或其他方式获取的 token |
返回值：
*ConnectionConfig：连接参数对象指针
4. func NewConnectionConfigFromJson(jsonStr string) (*ConnectionConfig, error)
通过 json 字符串来创建连接参数
参数说明
| 参数 | 类型 | 参数说明 |
|---|---|---|
| jsonStr | string | 描述连接参数的 json 字符串，有效字段如下：url，token，akid，akkey，appkey。其中必须包含 url 和 appkey，如果包含 token 则不需要包含 akid 和 akkey |
返回值：
*ConnectionConfig：连接对象指针
一句话识别
1. SpeechRecognitionStartParam
一句话识别参数
参数说明:
| 参数 | 类型 | 参数说明 |
|---|---|---|
| Format | string | 音频格式，默认使用 pcm |
| SampleRate | int | 采样率，默认 16000 |
| EnableIntermediateResult | bool | 是否打开中间结果返回 |
| EnablePunctuationPredition | bool | 是否打开标点预测 |
| EnableInverseTextNormalization | bool | 是否打开 ITN |
2. func DefaultSpeechRecognitionParam() SpeechRecognitionStartParam
返回一个默认的推荐参数，其中 format 为 pcm，采样率为 16000，中间结果，标点预测和 ITN 全开
参数说明：
无
返回值：
默认参数
3. func NewSpeechRecognition(...) (*SpeechRecognition, error)
创建一个 SpeechRecognition 实例
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| config | *ConnectionConfig | 见上文建立连接相关内容 |
| logger | *NlsLogger | 见 SDK 日志相关内容 |
| taskfailed | func(string, interface{}) | 识别过程中的错误处理回调，interface{}为用户自定义参数 |
| started | func(string, interface{}) | 建连完成回调 |
| resultchanged | func(string, interface{}) | 识别中间结果回调 |
| completed | func(string, interface{}) | 最终识别结果回调 |
| closed | func(interface{}) | 连接断开回调 |
| param | interface{} | 用户自定义参数 |
返回值：
*SpeechRecognition：识别对象指针
error：错误异常
4. func (sr *SpeechRecognition) Start(param SpeechRecognitionStartParam, extra map[string]interface{}) (chan bool, error)
根据 param 发起一次一句话识别
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| param | SpeechRecognitionStartParam | 一句话识别参数 |
| extra | map[string]interface{} | 额外 key value 参数 |
返回值：
chan bool：同步 start 完成的管道
error：错误异常
5. func (sr *SpeechRecognition) Stop() (chan bool, error)
停止一句话识别
参数说明：
无
返回值：
chan bool：同步 stop 完成的管道
error：错误异常
6. func (sr *SpeechRecognition) Shutdown()
强制断开连接
参数说明：
无
返回值：
无
7. func (sr *SpeechRecognition) SendAudioData(data []byte) error
发送音频，音频格式必须和参数中一致
参数说明
| 参数 | 类型 | 参数说明 |
|---|---|---|
| data | []byte | 音频数据 |
返回值：
error：异常错误
一句话识别代码示例：
package main
import (
"errors"
"flag"
"fmt"
"log"
"os"
"os/signal"
"sync"
"time"
"github.com/ikmak/alibabacloud-nls-go-sdk"
)
const (
AKID = "Your AKID"
AKKEY = "Your AKKEY"
//online key
APPKEY = "Your APPKEY"
TOKEN = "Your TOKEN"
)
func onTaskFailed(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("TaskFailed:", text)
}
func onStarted(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onStarted:", text)
}
func onResultChanged(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onResultChanged:", text)
}
func onCompleted(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onCompleted:", text)
}
func onClose(param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onClosed:")
}
func waitReady(ch chan bool, logger *nls.NlsLogger) error {
select {
case done := <-ch:
{
if !done {
logger.Println("Wait failed")
return errors.New("wait failed")
}
logger.Println("Wait done")
}
case <-time.After(20 * time.Second):
{
logger.Println("Wait timeout")
return errors.New("wait timeout")
}
}
return nil
}
var lk sync.Mutex
var fail = 0
var reqNum = 0
func testMultiInstance(num int) {
pcm, err := os.Open("tests/test1.pcm")
if err != nil {
log.Default().Fatalln(err)
}
buffers := nls.LoadPcmInChunk(pcm, 320)
param := nls.DefaultSpeechRecognitionParam()
//config := nls.NewConnectionConfigWithToken(PRE_URL_WSS,
// APPKEY, TOKEN)
config := nls.NewConnectionConfigWithAKInfoDefault(nls.DEFAULT_URL, APPKEY, AKID, AKKEY)
var wg sync.WaitGroup
for i := 0; i < num; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
strId := fmt.Sprintf("ID%d ", id)
logger := nls.NewNlsLogger(os.Stderr, strId, log.LstdFlags|log.Lmicroseconds)
logger.SetLogSil(false)
logger.SetDebug(true)
logger.Printf("Test Normal Case for SpeechRecognition:%s", strId)
sr, err := nls.NewSpeechRecognition(config, logger,
onTaskFailed, onStarted, onResultChanged,
onCompleted, onClose, logger)
if err != nil {
logger.Fatalln(err)
return
}
test_ex := make(map[string]interface{})
test_ex["test"] = "hello"
for {
lk.Lock()
reqNum++
lk.Unlock()
logger.Println("SR start")
ready, err := sr.Start(param, test_ex)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
sr.Shutdown()
continue
}
err = waitReady(ready, logger)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
sr.Shutdown()
continue
}
for _, data := range buffers.Data {
if data != nil {
sr.SendAudioData(data.Data)
time.Sleep(10 * time.Millisecond)
}
}
logger.Println("send audio done")
ready, err = sr.Stop()
if err != nil {
lk.Lock()
fail++
lk.Unlock()
sr.Shutdown()
continue
}
err = waitReady(ready, logger)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
sr.Shutdown()
continue
}
logger.Println("Sr done")
sr.Shutdown()
}
}(i)
}
wg.Wait()
}
func main() {
coroutineId := flag.Int("num", 1, "coroutine number")
flag.Parse()
log.Default().Printf("start %d coroutines", *coroutineId)
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
go func() {
for range c {
lk.Lock()
log.Printf(">>>>>>>>REQ NUM: %d>>>>>>>>>FAIL: %d", reqNum, fail)
lk.Unlock()
os.Exit(0)
}
}()
testMultiInstance(*coroutineId)
}
实时语音识别
1. SpeechTranscriptionStartParam
实时语音识别参数
参数说明:
| 参数 | 类型 | 参数说明 |
|---|---|---|
| Format | string | 音频格式，默认使用 pcm |
| SampleRate | int | 采样率，默认 16000 |
| EnableIntermediateResult | bool | 是否打开中间结果返回 |
| EnablePunctuationPredition | bool | 是否打开标点预测 |
| EnableInverseTextNormalization | bool | 是否打开 ITN |
| MaxSentenceSilence | int | 语音断句检测阈值，静音时长超过该阈值会被认为断句，合法参数范围 200 ～ 2000(ms)，默认值 800m |
| enable_words | bool | 是否开启返回词信息，可选，默认 false 不开启 |
2. func DefaultSpeechTranscriptionParam() SpeechTranscriptionStartParam
创建一个默认参数
参数说明：
无
返回值：
SpeechTranscriptionStartParam：默认参数
3. func NewSpeechTranscription(...) (*SpeechTranscription, error)
创建一个实时识别对象
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| config | *ConnectionConfig | 见上文建立连接相关内容 |
| logger | *NlsLogger | 见 SDK 日志相关内容 |
| taskfailed | func(string, interface{}) | 识别过程中的错误处理回调，interface{}为用户自定义参数 |
| started | func(string, interface{}) | 建连完成回调 |
| sentencebegin | func(string, interface{}) | 一句话开始 |
| sentenceend | func(string, interface{}) | 一句话结束 |
| resultchanged | func(string, interface{}) | 识别中间结果回调 |
| completed | func(string, interface{}) | 最终识别结果回调 |
| closed | func(interface{}) | 连接断开回调 |
| param | interface{} | 用户自定义参数 |
返回值：
*SpeechRecognition：识别对象指针
error：错误异常
4. func (st *SpeechTranscription) Start(param SpeechTranscriptionStartParam, extra map[string]interface{}) (chan bool, error)
开始实时识别
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| param | SpeechTranscriptionStartParam | 实时识别参数 |
| extra | map[string]interface{} | 额外 key value 参数 |
返回值：
chan bool：同步 start 完成的管道
error：错误异常
5. func (st *SpeechTranscription) Stop() (chan bool, error)
停止实时识别
参数说明：
无
返回值：
chan bool：同步 stop 完成的管道
error：错误异常
6. func (st *SpeechTranscription) Ctrl(param map[string]interface{}) error
发送控制命令，先阅读实时语音识别接口说明
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| param | map[string]interface{} | 自定义控制命令，该字典内容会以 key:value 形式合并进请求的 payload 段中 |
返回值：
error：错误异常
7. func (st *SpeechTranscription) Shutdown()
强制停止
参数说明：
无
返回值：
无
8. func (sr *SpeechTranscription) SendAudioData(data []byte) error
发送音频，音频格式必须和参数中一致
参数说明
| 参数 | 类型 | 参数说明 |
|---|---|---|
| data | []byte | 音频数据 |
返回值：
error：异常错误
代码示例
package main
import (
"errors"
"flag"
"fmt"
"log"
"os"
"os/signal"
"sync"
"time"
"github.com/ikmak/alibabacloud-nls-go-sdk"
)
const (
AKID = "Your AKID"
AKKEY = "Your AKKEY"
//online key
APPKEY = "Your APPKEY"
TOKEN = "Your TOKEN"
)
func onTaskFailed(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("TaskFailed:", text)
}
func onStarted(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onStarted:", text)
}
func onSentenceBegin(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onSentenceBegin:", text)
}
func onSentenceEnd(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onSentenceEnd:", text)
}
func onResultChanged(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onResultChanged:", text)
}
func onCompleted(text string, param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onCompleted:", text)
}
func onClose(param interface{}) {
logger, ok := param.(*nls.NlsLogger)
if !ok {
log.Default().Fatal("invalid logger")
return
}
logger.Println("onClosed:")
}
func waitReady(ch chan bool, logger *nls.NlsLogger) error {
select {
case done := <-ch:
{
if !done {
logger.Println("Wait failed")
return errors.New("wait failed")
}
logger.Println("Wait done")
}
case <-time.After(20 * time.Second):
{
logger.Println("Wait timeout")
return errors.New("wait timeout")
}
}
return nil
}
var lk sync.Mutex
var fail = 0
var reqNum = 0
func testMultiInstance(num int) {
pcm, err := os.Open("tests/test1.pcm")
if err != nil {
log.Default().Fatalln(err)
}
buffers := nls.LoadPcmInChunk(pcm, 320)
param := nls.DefaultSpeechTranscriptionParam()
//config := nls.NewConnectionConfigWithToken(PRE_URL_WSS,
// APPKEY, TOKEN)
config := nls.NewConnectionConfigWithAKInfoDefault(nls.DEFAULT_URL, APPKEY, AKID, AKKEY)
var wg sync.WaitGroup
for i := 0; i < num; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
strId := fmt.Sprintf("ID%d ", id)
logger := nls.NewNlsLogger(os.Stderr, strId, log.LstdFlags|log.Lmicroseconds)
logger.SetLogSil(false)
logger.SetDebug(true)
logger.Printf("Test Normal Case for SpeechRecognition:%s", strId)
st, err := nls.NewSpeechTranscription(config, logger,
onTaskFailed, onStarted,
onSentenceBegin, onSentenceEnd, onResultChanged,
onCompleted, onClose, logger)
if err != nil {
logger.Fatalln(err)
return
}
test_ex := make(map[string]interface{})
test_ex["test"] = "hello"
for {
lk.Lock()
reqNum++
lk.Unlock()
logger.Println("ST start")
ready, err := st.Start(param, test_ex)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
st.Shutdown()
continue
}
err = waitReady(ready, logger)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
st.Shutdown()
continue
}
for _, data := range buffers.Data {
if data != nil {
st.SendAudioData(data.Data)
time.Sleep(10 * time.Millisecond)
}
}
logger.Println("send audio done")
ready, err = st.Stop()
if err != nil {
lk.Lock()
fail++
lk.Unlock()
st.Shutdown()
continue
}
err = waitReady(ready, logger)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
st.Shutdown()
continue
}
logger.Println("Sr done")
st.Shutdown()
}
}(i)
}
wg.Wait()
}
func main() {
coroutineId := flag.Int("num", 1, "coroutine number")
flag.Parse()
log.Default().Printf("start %d coroutines", *coroutineId)
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
go func() {
for range c {
lk.Lock()
log.Printf(">>>>>>>>REQ NUM: %d>>>>>>>>>FAIL: %d", reqNum, fail)
lk.Unlock()
os.Exit(0)
}
}()
testMultiInstance(*coroutineId)
}
语音合成
1. SpeechSynthesisStartParam
参数说明:
| 参数 | 类型 | 参数说明 |
|---|---|---|
| Voice | string | 发音人，默认“xiaoyun” |
| Format | string | 音频格式，默认使用 wav |
| SampleRate | int | 采样率，默认 16000 |
| Volume | int | 音量，范围为 0-100，默认 50 |
| SpeechRate | int | 语速，范围为-500-500，默认为 0 |
| PitchRate | int | 音高，范围为-500-500，默认为 0 |
| EnableSubtitle | bool | 字幕功能，默认为 false |
2. func DefaultSpeechSynthesisParam() SpeechSynthesisStartParam
创建一个默认的语音合成参数
参数说明：
无
返回值：
SpeechSynthesisStartParam：语音合成参数
3. func NewSpeechSynthesis(...) (*SpeechSynthesis, error)
创建一个新的语音合成对象
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| config | *ConnectionConfig | 见上文建立连接相关内容 |
| logger | *NlsLogger | 见 SDK 日志相关内容 |
| taskfailed | func(string, interface{}) | 识别过程中的错误处理回调，interface{}为用户自定义参数 |
| synthesisresult | func([]byte, interface{}) | 语音合成数据回调 |
| metainfo | func(string, interface{}) | 字幕数据回调，需要参数中 EnableSubtitle 为 true |
| completed | func(string, interface{}) | 合成完毕结果回调 |
| closed | func(interface{}) | 连接断开回调 |
| param | interface{} | 用户自定义参数 |
返回值：
无
4. func (tts *SpeechSynthesis) Start(text string, param SpeechSynthesisStartParam, extra map[string]interface{}) (chan bool, error)
给定文本和参数进行语音合成
参数说明：
| 参数 | 类型 | 参数说明 |
|---|---|---|
| text | string | 待合成文本 |
| param | SpeechTranscriptionStartParam | 语音合成参数 |
| extra | map[string]interface{} | 额外 key value 参数 |
返回值：
chan bool：语音合成完成通知管道
error：错误异常
5. func (tts *SpeechSynthesis) Shutdown()
强制停止语音合成
参数说明：
无
返回值：
无
代码示例：
package main
import (
"errors"
"flag"
"fmt"
"io"
"log"
"os"
"os/signal"
"sync"
"time"
"github.com/ikmak/alibabacloud-nls-go-sdk"
)
const (
AKID = "Your AKID"
AKKEY = "Your AKKEY"
//online key
APPKEY = "Your APPKEY"
TOKEN = "Your TOKEN"
)
type TtsUserParam struct {
F io.Writer
Logger *nls.NlsLogger
}
func onTaskFailed(text string, param interface{}) {
p, ok := param.(*TtsUserParam)
if !ok {
log.Default().Fatal("invalid logger")
return
}
p.Logger.Println("TaskFailed:", text)
}
func onSynthesisResult(data []byte, param interface{}) {
p, ok := param.(*TtsUserParam)
if !ok {
log.Default().Fatal("invalid logger")
return
}
p.F.Write(data)
}
func onCompleted(text string, param interface{}) {
p, ok := param.(*TtsUserParam)
if !ok {
log.Default().Fatal("invalid logger")
return
}
p.Logger.Println("onCompleted:", text)
}
func onClose(param interface{}) {
p, ok := param.(*TtsUserParam)
if !ok {
log.Default().Fatal("invalid logger")
return
}
p.Logger.Println("onClosed:")
}
func waitReady(ch chan bool, logger *nls.NlsLogger) error {
select {
case done := <-ch:
{
if !done {
logger.Println("Wait failed")
return errors.New("wait failed")
}
logger.Println("Wait done")
}
case <-time.After(60 * time.Second):
{
logger.Println("Wait timeout")
return errors.New("wait timeout")
}
}
return nil
}
var lk sync.Mutex
var fail = 0
var reqNum = 0
const (
TEXT = "你好小德，今天天气怎么样。"
)
func testMultiInstance(num int) {
param := nls.DefaultSpeechSynthesisParam()
//config := nls.NewConnectionConfigWithToken(PRE_URL_WSS,
// APPKEY, TOKEN)
config := nls.NewConnectionConfigWithAKInfoDefault(nls.DEFAULT_URL, APPKEY, AKID, AKKEY)
var wg sync.WaitGroup
for i := 0; i < num; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
strId := fmt.Sprintf("ID%d ", id)
fname := fmt.Sprintf("ttsdump%d.wav", id)
ttsUserParam := new(TtsUserParam)
fout, err := os.OpenFile(fname, os.O_RDWR|os.O_TRUNC|os.O_CREATE, 0666)
logger := nls.NewNlsLogger(os.Stderr, strId, log.LstdFlags|log.Lmicroseconds)
logger.SetLogSil(false)
logger.SetDebug(true)
logger.Printf("Test Normal Case for SpeechRecognition:%s", strId)
ttsUserParam.F = fout
ttsUserParam.Logger = logger
tts, err := nls.NewSpeechSynthesis(config, logger,
onTaskFailed, onSynthesisResult, nil,
onCompleted, onClose, ttsUserParam)
if err != nil {
logger.Fatalln(err)
return
}
for {
lk.Lock()
reqNum++
lk.Unlock()
logger.Println("SR start")
ch, err := tts.Start(TEXT, param, nil)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
tts.Shutdown()
continue
}
err = waitReady(ch, logger)
if err != nil {
lk.Lock()
fail++
lk.Unlock()
tts.Shutdown()
continue
}
logger.Println("Synthesis done")
tts.Shutdown()
}
}(i)
}
wg.Wait()
}
func main() {
coroutineId := flag.Int("num", 1, "coroutine number")
flag.Parse()
log.Default().Printf("start %d coroutines", *coroutineId)
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
go func() {
for range c {
lk.Lock()
log.Printf(">>>>>>>>REQ NUM: %d>>>>>>>>>FAIL: %d", reqNum, fail)
lk.Unlock()
os.Exit(0)
}
}()
testMultiInstance(*coroutineId)
}
Documentation
¶
Index ¶
- Constants
- Variables
- type Chunk
- type ChunkBuffer
- type CommonRequest
- type CommonResponse
- type ConnectionConfig
- type Context
- type Header
- type NlsLogger
- func (l *NlsLogger) Debugf(format string, v ...interface{})
- func (l *NlsLogger) Debugln(v ...interface{})
- func (l *NlsLogger) Fatal(v ...interface{})
- func (l *NlsLogger) Fatalf(format string, v ...interface{})
- func (l *NlsLogger) Fatalln(v ...interface{})
- func (l *NlsLogger) Panic(v ...interface{})
- func (l *NlsLogger) Panicf(format string, v ...interface{})
- func (l *NlsLogger) Print(v ...interface{})
- func (l *NlsLogger) Printf(format string, v ...interface{})
- func (l *NlsLogger) Println(v ...interface{})
- func (l *NlsLogger) SetDebug(debug bool)
- func (l *NlsLogger) SetFlags(flags int)
- func (l *NlsLogger) SetLogSil(sil bool)
- func (l *NlsLogger) SetOutput(w io.Writer)
- func (l *NlsLogger) SetPrefix(prefix string)
- type SDK
- type SpeechRecognition
- type SpeechRecognitionStartParam
- type SpeechSynthesis
- type SpeechSynthesisStartParam
- type SpeechTranscription
- func (st *SpeechTranscription) Ctrl(param map[string]interface{}) error
- func (st *SpeechTranscription) SendAudioData(data []byte) error
- func (st *SpeechTranscription) Shutdown()
- func (st *SpeechTranscription) Start(param SpeechTranscriptionStartParam, extra map[string]interface{}) (chan bool, error)
- func (st *SpeechTranscription) Stop() (chan bool, error)
- type SpeechTranscriptionStartParam
- type TokenResult
- type TokenResultMessage
Constants ¶
View Source
const ( CONNECTED_HANDLER = "CONNECTED_HANDLER" CLOSE_HANDLER = "CLOSE_HANDLER" RAW_HANDLER = "RAW_HANDLER" )
View Source
const ( //namespace field SR_NAMESPACE = "SpeechRecognizer" //name field SR_START_NAME = "StartRecognition" SR_STOP_NAME = "StopRecognition" SR_STARTED_NAME = "RecognitionStarted" SR_RESULT_CHG_NAME = "RecognitionResultChanged" SR_COMPLETED_NAME = "RecognitionCompleted" )
View Source
const ( //namespace field ST_NAMESPACE = "SpeechTranscriber" //name field ST_START_NAME = "StartTranscription" ST_STOP_NAME = "StopTranscription" ST_CTRL_NAME = "ControlTranscriber" ST_STARTED_NAME = "TranscriptionStarted" ST_SENTENCE_BEGIN_NAME = "SentenceBegin" ST_SENTENCE_END_NAME = "SentenceEnd" ST_RESULT_CHG_NAME = "TranscriptionResultChanged" ST_COMPLETED_NAME = "TranscriptionCompleted" )
View Source
const ( //namespace field TTS_NAMESPACE = "SpeechSynthesizer" TTS_LONG_NAMESPACE = "SpeechLongSynthesizer" //name field TTS_START_NAME = "StartSynthesis" TTS_COMPLETED_NAME = "SynthesisCompleted" TTS_METAINFO_NAME = "MetaInfo" )
View Source
const ( SDK_VERSION = "0.0.1fix" SDK_NAME = "nls-go-sdk" SDK_LANGUAGE = "go" //AFORMAT PCM = "pcm" WAV = "wav" OPUS = "opus" OPU = "opu" //token DEFAULT_DISTRIBUTE = "cn-shanghai" DEFAULT_DOMAIN = "nls-meta.cn-shanghai.aliyuncs.com" DEFAULT_VERSION = "2019-02-28" DEFAULT_SEC_WEBSOCKET_KEY = "x3JJHMbDL1EzLkh9GBhXDw==" DEFAULT_SEC_WEBSOCKET_VER = "13" DEFAULT_X_NLS_TOKEN_KEY = "X-NLS-Token" DEFAULT_URL = "wss://nls-gateway.aliyuncs.com/ws/v1" TASK_FAILED_NAME = "TaskFailed" AUDIO_FORMAT_KEY = "format" SAMPLE_RATE_KEY = "sample_rate" ENABLE_INTERMEDIATE_KEY = "enable_intermediate_result" ENABLE_PP_KEY = "enable_punctuation_prediction" ENABLE_ITN_KEY = "enable_inverse_text_normalization" )
Variables ¶
View Source
var DefaultContext = Context{ Sdk: SDK{ Name: SDK_NAME, Version: SDK_VERSION, Language: SDK_LANGUAGE, }, }
Functions ¶
This section is empty.
Types ¶
type ChunkBuffer ¶
type ChunkBuffer struct {
Data []*Chunk
}
func LoadPcmInChunk ¶
func LoadPcmInChunk(r io.Reader, chunkSize int) *ChunkBuffer
type CommonRequest ¶
type CommonResponse ¶
type ConnectionConfig ¶
type ConnectionConfig struct {
Url string `json:"url"`
Token string `json:"token"`
Akid string `json:"akid"`
Akkey string `json:"akkey"`
Appkey string `json:"appkey"`
Rbuffer int `json:"rbuffer"`
Wbuffer int `json:"wbuffer"`
}
func NewConnectionConfigFromJson ¶
func NewConnectionConfigFromJson(jsonStr string) (*ConnectionConfig, error)
func NewConnectionConfigWithToken ¶
func NewConnectionConfigWithToken(url string, appkey string, token string) *ConnectionConfig
type Context ¶
type Context struct {
Sdk SDK `json:"sdk"`
App map[string]interface{} `json:"app,omitempty"`
System map[string]interface{} `json:"system,omitempty"`
Device map[string]interface{} `json:"device,omitempty"`
Network map[string]interface{} `json:"network,omitempty"`
Geography map[string]interface{} `json:"geography,omitempty"`
Bridge map[string]interface{} `json:"bridge,omitempty"`
Custom map[string]interface{} `json:"custom,omitempty"`
}
type NlsLogger ¶
type NlsLogger struct {
// contains filtered or unexported fields
}
func DefaultNlsLog ¶
func DefaultNlsLog() *NlsLogger
type SpeechRecognition ¶
type SpeechRecognition struct {
StartParam map[string]interface{}
UserParam interface{}
// contains filtered or unexported fields
}
func NewSpeechRecognition ¶
func NewSpeechRecognition(config *ConnectionConfig, logger *NlsLogger, taskfailed func(string, interface{}), started func(string, interface{}), resultchanged func(string, interface{}), completed func(string, interface{}), closed func(interface{}), param interface{}) (*SpeechRecognition, error)
func (*SpeechRecognition) SendAudioData ¶
func (sr *SpeechRecognition) SendAudioData(data []byte) error
func (*SpeechRecognition) Shutdown ¶
func (sr *SpeechRecognition) Shutdown()
func (*SpeechRecognition) Start ¶
func (sr *SpeechRecognition) Start(param SpeechRecognitionStartParam, extra map[string]interface{}) (chan bool, error)
func (*SpeechRecognition) Stop ¶
func (sr *SpeechRecognition) Stop() (chan bool, error)
type SpeechRecognitionStartParam ¶
type SpeechRecognitionStartParam struct {
Format string `json:"format,omitempty"`
SampleRate int `json:"sample_rate,omitempty"`
EnableIntermediateResult bool `json:"enable_intermediate_result"`
EnablePunctuationPrediction bool `json:"enable_punctuation_prediction"`
EnableInverseTextNormalization bool `json:"enable_inverse_text_normalization"`
}
func DefaultSpeechRecognitionParam ¶
func DefaultSpeechRecognitionParam() SpeechRecognitionStartParam
type SpeechSynthesis ¶
type SpeechSynthesis struct {
StartParam map[string]interface{}
UserParam interface{}
// contains filtered or unexported fields
}
func NewSpeechSynthesis ¶
func NewSpeechSynthesis(config *ConnectionConfig, logger *NlsLogger, realtimeLongText bool, taskfailed func(string, interface{}), synthesisresult func([]byte, interface{}), metainfo func(string, interface{}), completed func(string, interface{}), closed func(interface{}), param interface{}) (*SpeechSynthesis, error)
func (*SpeechSynthesis) Shutdown ¶
func (tts *SpeechSynthesis) Shutdown()
func (*SpeechSynthesis) Start ¶
func (tts *SpeechSynthesis) Start(text string, param SpeechSynthesisStartParam, extra map[string]interface{}) (chan bool, error)
type SpeechSynthesisStartParam ¶
type SpeechSynthesisStartParam struct {
Voice string `json:"voice"`
Format string `json:"format,omitempty"`
SampleRate int `json:"sample_rate,omitempty"`
Volume int `json:"volume"`
SpeechRate int `json:"speech_rate"`
PitchRate int `json:"pitch_rate"`
EnableSubtitle bool `json:"enable_subtitle"`
}
func DefaultSpeechSynthesisParam ¶
func DefaultSpeechSynthesisParam() SpeechSynthesisStartParam
type SpeechTranscription ¶
type SpeechTranscription struct {
StartParam map[string]interface{}
UserParam interface{}
// contains filtered or unexported fields
}
func NewSpeechTranscription ¶
func NewSpeechTranscription(config *ConnectionConfig, logger *NlsLogger, taskfailed func(string, interface{}), started func(string, interface{}), sentencebegin func(string, interface{}), sentenceend func(string, interface{}), resultchanged func(string, interface{}), completed func(string, interface{}), closed func(interface{}), param interface{}) (*SpeechTranscription, error)
func (*SpeechTranscription) Ctrl ¶
func (st *SpeechTranscription) Ctrl(param map[string]interface{}) error
func (*SpeechTranscription) SendAudioData ¶
func (st *SpeechTranscription) SendAudioData(data []byte) error
func (*SpeechTranscription) Shutdown ¶
func (st *SpeechTranscription) Shutdown()
func (*SpeechTranscription) Start ¶
func (st *SpeechTranscription) Start(param SpeechTranscriptionStartParam, extra map[string]interface{}) (chan bool, error)
func (*SpeechTranscription) Stop ¶
func (st *SpeechTranscription) Stop() (chan bool, error)
type SpeechTranscriptionStartParam ¶
type SpeechTranscriptionStartParam struct {
Format string `json:"format,omitempty"`
SampleRate int `json:"sample_rate,omitempty"`
EnableIntermediateResult bool `json:"enable_intermediate_result"`
EnablePunctuationPrediction bool `json:"enable_punctuation_prediction"`
EnableInverseTextNormalization bool `json:"enable_inverse_text_normalization"`
MaxSentenceSilence int `json:"max_sentence_silence,omitempty"`
EnableWords bool `json:"enable_words"`
}
func DefaultSpeechTranscriptionParam ¶
func DefaultSpeechTranscriptionParam() SpeechTranscriptionStartParam
type TokenResult ¶
type TokenResultMessage ¶
type TokenResultMessage struct {
ErrMsg string `json:"ErrMsg"`
TokenResult TokenResult `json:"Token"`
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.