Go SDK

ConnectionConfig

ConnectionConfig stores connection parameters. Initialize it with a token, or use the provided AccessKey initialization method to obtain a token before establishing a connection.

When constructing ConnectionConfig directly, provide a valid token. Automatic token retrieval is performed by NewConnectionConfigWithAKInfoDefault and JSON initialization without a token.

Initialize the connection configuration

Choose an initialization method. Use the selected snippet to replace the code from credential retrieval through config creation in the complete example.

func NewConnectionConfigWithToken(url string, appkey string, token string) *ConnectionConfig

appkey := os.Getenv("NLS_APP_KEY")
token := os.Getenv("NLS_TOKEN")
if appkey == "" || token == "" {
    return errors.New("set NLS_APP_KEY and NLS_TOKEN")
}
config := nls.NewConnectionConfigWithToken(nls.DEFAULT_URL, appkey, token)

func NewConnectionConfigWithAKInfoDefault(url string, appkey string, akid string, akkey string) (*ConnectionConfig, error)

appkey := os.Getenv("NLS_APP_KEY")
akid := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
akkey := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
if appkey == "" || akid == "" || akkey == "" {
    return errors.New("set NLS_APP_KEY and AccessKey environment variables")
}
config, err := nls.NewConnectionConfigWithAKInfoDefault(
    nls.DEFAULT_URL, appkey, akid, akkey)
if err != nil {
    return err
}

func NewConnectionConfigFromJson(jsonStr string) (*ConnectionConfig, error)

appkey := os.Getenv("NLS_APP_KEY")
token := os.Getenv("NLS_TOKEN")
if appkey == "" || token == "" {
    return errors.New("set NLS_APP_KEY and NLS_TOKEN")
}
configJSON, err := json.Marshal(map[string]string{
    "url":    nls.DEFAULT_URL,
    "appkey": appkey,
    "token":  token,
})
if err != nil {
    return err
}
config, err := nls.NewConnectionConfigFromJson(string(configJSON))
if err != nil {
    return err
}

Synthesis parameters

SpeechSynthesisStartParam contains the following parameters.

Default synthesis parameters

DefaultSpeechSynthesisParam returns a SpeechSynthesisStartParam with the defaults listed above. It takes no parameters.

func DefaultSpeechSynthesisParam() SpeechSynthesisStartParam

Create a synthesis object

NewSpeechSynthesis creates a synthesis object and returns *SpeechSynthesis and error.

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)

Start synthesis

Start starts synthesis with the specified text and parameters.

func (tts *SpeechSynthesis) Start(text string, param SpeechSynthesisStartParam,
    extra map[string]interface{}) (chan bool, error)

When using a voice that supports multiple emotions, set the emotion in text with the <emotion> tag. This tag applies only to voices that support multiple emotions. For usage, see the SSML emotion tag.

Return values:

• chan bool: the synthesis completion notification channel. It receives true when synthesis completes, or false when the task fails or is stopped by Shutdown. Audio data is delivered through the synthesisresult callback.

• error: an error encountered when starting the operation. Server-side task errors are delivered through the taskfailed callback.

Stop synthesis

Shutdown closes the connection and stops any unfinished synthesis. It takes no parameters and returns no value. Call it after the operation to release the connection.

func (tts *SpeechSynthesis) Shutdown()

Default logger

DefaultNlsLog returns the globally shared *NlsLogger and takes no parameters. The default logger writes to standard error with the prefix NLS.

func DefaultNlsLog() *NlsLogger

Create a logger

NewNlsLogger returns a new *NlsLogger.

func NewNlsLogger(w io.Writer, tag string, flag int) *NlsLogger

Control standard logging

SetLogSil controls output from Print, Printf, and Println. Set sil to true to disable output, or false to enable it. This setting does not affect Debug, Fatal, or Panic methods. The method returns no value.

func (logger *NlsLogger) SetLogSil(sil bool)

Control debug logging

SetDebug controls output from Debugf and Debugln. Set debug to true to enable output, or false to disable it. The method returns no value.

func (logger *NlsLogger) SetDebug(debug bool)

Log output destination

SetOutput directs log output to w, which implements io.Writer. The method returns no value.

func (logger *NlsLogger) SetOutput(w io.Writer)

Log prefix

SetPrefix sets the prefix at the start of log lines to prefix. The method returns no value.

func (logger *NlsLogger) SetPrefix(prefix string)

Log flags

SetFlags sets the log flags and returns no value. For flags values, see Go log constants.

func (logger *NlsLogger) SetFlags(flags int)

Print logs

For log formatting rules, see the Go log documentation.

How do I resolve websocket: bad handshake?

This error indicates that the WebSocket handshake failed. Check that the endpoint is correct, the token is valid, and the network can reach the endpoint. If the token has expired, obtain a new one before reconnecting.

The Appkey is used to authenticate synthesis requests. If a TaskFailed event is received, use the event's error message to check the project Appkey, service status, and request parameters.