C# SDK

SDK下载

可通过以下两种方法获取SDK。

• 方法一：从GitHub获取最新源码，详细编译和运行方式可见下文，或查看源码中的readme.md。

git clone --depth 1 https://github.com/aliyun/alibabacloud-nls-cpp-sdk

• 方法二：直接从下文表中选取需要的SDK包进行下载。其中SDK源码包为SDK原始代码，需要通过下文编译方法生成集成所需的库文件。其他对应平台的SDK包内含相关库文件、头文件，无需编译。

其中：

• alibabacloud-nls-cpp-sdk<version>-master_<github commit id>.zip为SDK源码包。

• NlsCsharpSdk_Windows_<版本号>_<github commit id>.zip为Windows平台下开发需要的SDK包，详见内部readme.md。

Windows平台C#编译运行

推荐直接使用已经编译好的库NlsCsharpSdk_Windows_<version>_<github commit id>.zip进行集成。若有编译需求，请下载alibabacloud-nls-cpp-sdk<version>-master_<github commit id>.zip并解压到本地，或从GitHub获取最新代码，然后参考其中readme.md的编译步骤。

关键接口

using nlsCsharpSdk;

• 基础接口

  • NlsClient：语音处理客户端，利用该客户端可以进行一句话识别、实时语音识别和语音合成的语音处理任务。该客户端为线程安全，建议全局仅创建一个实例。

    接口名	功能描述
    SetLogConfig	设置日志文件与存储路径。
    StartWorkThread	启动工作线程数，默认1即启动一个线程，若-1则启动CPU核数的线程数。在高并发的情况下建议选择-1。这一接口有初始化NlsClient的作用。
    ReleaseInstance	销毁NlsClient对象实例，即释放NLS SDK。
    GetVersion	获取SDK版本号。
    CreateSynthesizerRequest	创建语音合成对象，线程安全，支持高并发请求。
    CreateSynthesizerRequest	销毁语音合成对象，需要在当前请求的closed事件后调用。

  • NlsToken：创建Token对象，用于申请获取TokenId。申请新Token时需要先获取有效时间戳，若超过有效时间则再申请。若在有效时间内多次申请Token会导致TokenId错误而无法使用。

    接口名	功能描述
    SetAccessKeyId	设置阿里云账号AccessKey ID。
    SetKeySecret	设置阿里云账号AccessKey Secret。
    ApplyNlsToken	申请获取TokenId。
    GetToken	获取TokenId。
    GetExpireTime	获取Token有效期时间戳（秒）。

  • NlsEvent：事件对象，您可以从中获取Request状态码、云端返回结果、失败信息等。

    接口名	功能描述
    statusCode	获取状态码，正常情况为0或者20000000，失败时对应失败的错误码。
    taskId	获取任务的TaskId。
    msg	获取云端返回的response结果。
    result	获取云端返回的识别结果。

• 识别接口

  SpeechSynthesizerRequest：语音合成请求对象，用于语音合成及长文本语音合成。

  接口名	功能描述
  SetOnSynthesisCompleted	设置语音合成结束回调函数。
  SetOnChannelClosed	设置通道关闭回调函数。
  SetOnTaskFailed	设置错误回调函数。
  SetOnBinaryDataReceived	设置语音合成二进制音频数据接收回调函数。
  SetOnMetaInfo	设置文本对应的日志信息接收回调函数。
  SetAppKey	设置Appkey。
  SetToken	口令认证。所有的请求都必须通过SetToken方法认证通过，才可以使用。
  SetUrl	设置服务URL地址。
  SetText	待合成音频文本内容text设置。
  SetVoice	发音人voice设置。
  SetVolume	音量volume设置。
  SetFormat	输出音频编码格式Format设置。
  SetSampleRate	音频采样率设置。
  SetSpeechRate	语速设置。
  SetPitchRate	语调设置。
  SetEnableSubtitle	是否开启字幕功能。
  Start	启动SpeechSynthesizerRequest。
  Cancel	不会与服务端确认关闭，直接关闭语音合成过程。

错误码

服务端响应状态码

关于服务状态码，请参见服务状态码。

代码示例

using System;
using System.IO;
using System.Threading;
using System.Windows.Forms;
using nlsCsharpSdk;

namespace nlsCsharpSdkDemo
{
    public partial class nlsCsharpSdkDemo : Form
    {
        private NlsClient nlsClient;
        private SpeechSynthesizerRequest syPtr;
        private NlsToken tokenPtr;
        private UInt64 expireTime;

        private string appKey;
        private string akId;
        private string akSecret;
        private string token;
        private string url;

        static bool running;
        static string cur_nls_result;

        static string cur_sy_completed;
        static string cur_sy_closed;

        private void FlushLab()
        {
            while (running)
            {
                if (cur_nls_result != null && cur_nls_result.Length > 0)
                {
                    nlsResult.Text = cur_nls_result;
                }

                if (cur_st_result != null && cur_st_result.Length > 0)
                {
                    stResult.Text = cur_st_result;
                }
                if (cur_st_completed != null && cur_st_completed.Length > 0)
                {
                    stCompleted.Text = cur_st_completed;
                }
                if (cur_st_closed != null && cur_st_closed.Length > 0)
                {
                    stClosed.Text = cur_st_closed;
                }

                if (cur_sr_result != null && cur_sr_result.Length > 0)
                {
                    srResult.Text = cur_sr_result;
                }
                if (cur_sr_completed != null && cur_sr_completed.Length > 0)
                {
                    srCompleted.Text = cur_sr_completed;
                }
                if (cur_sr_closed != null && cur_sr_closed.Length > 0)
                {
                    srClosed.Text = cur_sr_closed;
                }

                if (cur_sy_completed != null && cur_sy_completed.Length > 0)
                {
                    syCompleted.Text = cur_sy_completed;
                }
                if (cur_sy_closed != null && cur_sy_closed.Length > 0)
                {
                    syClosed.Text = cur_sy_closed;
                }
                Thread.Sleep(200);
            }
        }

        public nlsCsharpSdkDemo()
        {
            InitializeComponent();
            System.Windows.Forms.Control.CheckForIllegalCrossThreadCalls = false;//设置该属性 为false

            nlsClient = new NlsClient();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            int ret = nlsClient.SetLogConfig("nlsLog", LogLevel.LogDebug, 400, 10);
            if (ret == 0)
                nlsResult.Text = "OpenLog Success";
            else
                nlsResult.Text = "OpenLog Failed";
        }

        private void button1_Click_1(object sender, EventArgs e)
        {
            string version = nlsClient.GetVersion();
            nlsResult.Text = version;
        }

        private void button1_Click_2(object sender, EventArgs e)
        {
            nlsClient.StartWorkThread(-1);
            nlsResult.Text = "StartWorkThread and init NLS success.";
            running = true;
            Thread t = new Thread(FlushLab);
            t.Start();
        }

        private void button1_Click_3(object sender, EventArgs e)
        {
            nlsClient.ReleaseInstance();
            nlsResult.Text = "Release NLS success.";
        }

        #region Info
        private void textBox1_TextChanged(object sender, EventArgs e)
        {
            akId = tAkId.Text;
        }

        private void tAppKey_TextChanged(object sender, EventArgs e)
        {
            appKey = tAppKey.Text;
        }

        private void tAkSecret_TextChanged(object sender, EventArgs e)
        {
            akSecret = tAkSecret.Text;
        }

        private void tToken_TextChanged(object sender, EventArgs e)
        {
            token = tToken.Text;
        }

        private void tUrl_TextChanged(object sender, EventArgs e)
        {
            url = tUrl.Text;
        }
        #endregion

        #region TokenButton
        // create token
        private void button3_Click_1(object sender, EventArgs e)
        {
            int ret = -1;
            tokenPtr = nlsClient.CreateNlsToken();
            if (tokenPtr.native_token != IntPtr.Zero)
            {
                if (akId != null && akSecret != null & akId.Length > 0 && akSecret.Length > 0)
                {
                    tokenPtr.SetAccessKeyId(tokenPtr, akId);
                    tokenPtr.SetKeySecret(tokenPtr, akSecret);

                    ret = tokenPtr.ApplyNlsToken(tokenPtr);
                    if (ret == -1)
                    {
                        System.Diagnostics.Debug.WriteLine("ApplyNlsToken failed");
                        nlsResult.Text = tokenPtr.GetErrorMsg(tokenPtr);
                    }
                    else
                    {
                        System.Diagnostics.Debug.WriteLine("ApplyNlsToken success");
                        token = tokenPtr.GetToken(tokenPtr);
                        tToken.Text = token;
                        expireTime = tokenPtr.GetExpireTime(tokenPtr);
                        nlsResult.Text = "ExpireTime:" + expireTime.ToString();
                    }
                }
                else
                {
                    nlsResult.Text = "CreateToken Failed, akId or Secret is null";
                }
            }
            else
            {
                nlsResult.Text = "CreateToken Failed";
            }
        }

        // release token
        private void button4_Click(object sender, EventArgs e)
        {
            if (tokenPtr.native_token != IntPtr.Zero)
            {
                nlsClient.ReleaseNlsToken(tokenPtr);
                tokenPtr.native_token = IntPtr.Zero;
                nlsResult.Text = "ReleaseNlsToken Success";
            }
            else
            {
                nlsResult.Text = "ReleaseNlsToken is nullptr";
            }
        }
        #endregion

        #region SynthesizerCallback
        private CallbackDelegate DemoOnBinaryDataReceived =
            (ref NLS_EVENT_STRUCT e) =>
            {
                FileStream fs;
                String filename = e.taskId + ".pcm";
                if (File.Exists(filename))
                {
                    fs = new FileStream(filename, FileMode.Append, FileAccess.Write);
                }
                else
                {
                    fs = new FileStream(filename, FileMode.Create, FileAccess.Write);
                }
                fs.Write(e.binaryData, 0, e.binaryDataSize);
                fs.Close();
            };
        private CallbackDelegate DemoOnSynthesisClosed =
            (ref NLS_EVENT_STRUCT e) =>
            {
                System.Diagnostics.Debug.WriteLine("DemoOnSynthesisClosed = {0}", e.msg);
                cur_sy_closed = "msg : " + e.msg;
            };
        private CallbackDelegate DemoOnSynthesisTaskFailed =
            (ref NLS_EVENT_STRUCT e) =>
            {
                System.Diagnostics.Debug.WriteLine("DemoOnSynthesisTaskFailed = {0}", e.msg);
                cur_sy_completed = "msg : " + e.msg;
            };
        private CallbackDelegate DemoOnSynthesisCompleted =
            (ref NLS_EVENT_STRUCT e) =>
            {
                System.Diagnostics.Debug.WriteLine("DemoOnSynthesisCompleted = {0}", e.msg);
                cur_sy_completed = "result : " + e.msg;
            };
        private CallbackDelegate DemoOnMetaInfo =
            (ref NLS_EVENT_STRUCT e) =>
            {
                System.Diagnostics.Debug.WriteLine("DemoOnMetaInfo = {0}", e.msg);
                //cur_sy_completed = "metaInfo : " + e.msg;
            };
        #endregion

        // create synthesizer
        private void button12_Click(object sender, EventArgs e)
        {
            syPtr = nlsClient.CreateSynthesizerRequest(TtsVersion.ShortTts);
            if (syPtr.native_request != IntPtr.Zero)
            {
                nlsResult.Text = "CreateSynthesizerRequest Success";
            }
            else
            {
                nlsResult.Text = "CreateSynthesizerRequest Failed";
            }
            cur_sy_closed = "null";
            cur_sy_completed = "null";
        }

        // start synthesizer
        private void button10_Click(object sender, EventArgs e)
        {
            int ret = -1;
            if (syPtr.native_request != IntPtr.Zero)
            {
                syPtr.SetAppKey(syPtr, appKey);
                syPtr.SetToken(syPtr, token);
                syPtr.SetUrl(syPtr, url);
                syPtr.SetText(syPtr, "今天天气真不错，我想去操场踢足球。");
                syPtr.SetVoice(syPtr, "siqi");
                syPtr.SetVolume(syPtr, 50);
                syPtr.SetFormat(syPtr, "wav");
                syPtr.SetSampleRate(syPtr, 16000);
                syPtr.SetSpeechRate(syPtr, 0);
                syPtr.SetPitchRate(syPtr, 0);
                syPtr.SetEnableSubtitle(syPtr, true);

                syPtr.SetOnSynthesisCompleted(syPtr, DemoOnSynthesisCompleted, IntPtr.Zero);
                syPtr.SetOnBinaryDataReceived(syPtr, DemoOnBinaryDataReceived, IntPtr.Zero);
                syPtr.SetOnTaskFailed(syPtr, DemoOnSynthesisTaskFailed, IntPtr.Zero);
                syPtr.SetOnChannelClosed(syPtr, DemoOnSynthesisClosed, IntPtr.Zero);
                syPtr.SetOnMetaInfo(syPtr, DemoOnMetaInfo, IntPtr.Zero);

                ret = syPtr.Start(syPtr);
            }

            if (ret != 0)
            {
                nlsResult.Text = "Synthesizer Start failed";
            }
            else
            {
                nlsResult.Text = "Synthesizer Start success";
            }
        }

        // cancel synthesizer
        private void button9_Click(object sender, EventArgs e)
        {
            int ret = -1;
            if (syPtr.native_request != IntPtr.Zero)
                ret = syPtr.Cancel(syPtr);

            if (ret != 0)
            {
                nlsResult.Text = "Synthesizer Cancel failed";
            }
            else
            {
                nlsResult.Text = "Synthesizer Cancel success";
            }
        }

        private void btnSYrelease_Click(object sender, EventArgs e)
        {
            if (syPtr.native_request != IntPtr.Zero)
            {
                nlsClient.ReleaseSynthesizerRequest(syPtr);
                syPtr.native_request = IntPtr.Zero;
                nlsResult.Text = "ReleaseSynthesizerRequest Success";
            }
            else
            {
                nlsResult.Text = "ReleaseSynthesizerRequest is nullptr";
            }
            cur_sy_closed = "null";
            cur_sy_completed = "null";
        }
    }
}