# xfyun-node

**Repository Path**: ancodehub/xfyun-node

## Basic Information

- **Project Name**: xfyun-node
- **Description**: Speech to Text SDK for Node.js
- **Primary Language**: C
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-12
- **Last Updated**: 2024-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xfyun-node
[科大讯飞](http://www.xfyun.cn/)没有提供Node.js SDK，于是就有了这个轮子。
* 目前仅支持 linux64，目前仅支持科大讯飞听写接口。

```
# download xfyun sdks from official portal, a zip file like here.
sudo unzip Linux_voice_1135_5864ae2d.zip -d /opt/xfy-sdk
cd PROJECT_ROOT
```

* Install
```
npm install xfy-node --save
```

## Usage
```
    const xfyclient = require('xfy-node');
    let params = {
        username: null, // 账号名称
        password: null, // 账号密码 
        appid: '5864ae2d', // AppID
        // 语言
        // zh_cn:简体中文
        // zh_tw:繁体中文
        // en_us:英语
        // 默认为zh_cn
        lang: 'zh_cn', 
        // 口音
        // mandarin:普通话
        // cantonese:粤语
        // 默认为mandarin
        accent: 'mandarin',
        // 音频格式
        // 8000, 16000, 默认为16000
        sample_rate: 16000,
        // 音频文件位置，绝对路径
        audio_file: 'wav/iflytek01.wav'
    }

    xfyclient.iat(params)
        .then(function (result) {
            console.log('result', result);
        }, function(err){
            console.log('err', err);
        });
```

## Tutorial
https://github.com/Samurais/xfy-node-getstarted

## Contribution
```
npm install
node-gyp rebuild
ava # test
```

## 讯飞提供的原始SDK
```
git clone https://github.com/Samurais/xfyun-get-started
```

## 资源链接
[语音识别科普](http://bbs.xfyun.cn/forum.php?mod=viewthread&tid=6911)

[服务介绍](http://www.xfyun.cn/doccenter/asr)

[开发者论坛](http://bbs.xfyun.cn/portal.php)

[识别英语](http://bbs.xfyun.cn/forum.php?mod=viewthread&tid=22602&extra=page%3D1)

# Copyright & License

Code & Docs 2017© Hai Liang Wang hailiang.hl.wang@gmail.com

Code released under the ISC license

Docs released under Creative Commons