Sambert Speech Synthesis iOS SDK

nui_tts_initialize

Initializes the speech synthesis SDK instance. The SDK is a singleton. Do not initialize the instance again before you call <a baseurl="t3161921_v1_0_0.xdita" data-node="6176237" data-root="85177" data-tag="xref" href="#6c2931e9ae3eq" id="6161b501fajbh">nui_tts_release</a>.

• Method signature

  -(int) nui_tts_initialize:(const char *)parameters
                   logLevel:(NuiSdkLogLevel)level
                    saveLog:(BOOL)save_log;

• Parameter descriptions

  Parameter	Type	Description
  parameters	char*	A JSON string that contains authentication, connection, and debugging parameters. For more information, see Connection and control parameters.
  level	NuiSdkLogLevel	Controls the logging level of the SDK itself.
  save_log	BOOL	Specifies whether to save binary logs. If this parameter is set to YES, you must use the debug_path parameter to specify a path in Connection and control parameters. You can also use max_log_file_size to set the file size.

• Return value description

  Returns an error code. For more information, see Query error codes.

nui_tts_set_param

Before calling <a baseurl="t3161921_v1_0_0.xdita" data-node="6176237" data-root="85177" data-tag="xref" href="#8fe6ea298apzu" id="97393f5763ycp">nui_tts_play</a>, you must set the speech synthesis effect parameters as key-value pairs.

• Method signature

  -(int) nui_tts_set_param:(const char *)param
                     value:(const char *)value;

• Parameter descriptions

  Parameter	Type	Description
  param	char*	The name of the speech synthesis effect parameter.
  value	char*	The value of the speech synthesis effect parameter.

• Return value description

  Returns an error code. For more information, see Query error codes.

nui_tts_get_param

Retrieves a parameter value. This method is mainly used for troubleshooting.

• Method signature

  -(const char *) nui_tts_get_param:(const char *)param;

• Parameter descriptions

  Parameter	Type	Description
  param	char*	The parameter. Currently, only "error_msg" is supported.

• Return value description

  Returns the parameter value.

nui_tts_play

Starts a speech synthesis task.

• Method signature

  -(int) nui_tts_play:(const char *)priority
               taskId:(const char *)taskid
                text:(const char *)text;

• Parameter descriptions

  Parameter	Type	Description
  priority	char*	The task priority. Set this parameter to 1.
  taskid	char*	The task ID. If you pass null, the SDK automatically generates a task ID.
  text	char*	The text to be synthesized.

• Return value description

  Returns an error code. For more information, see Query error codes.

nui_tts_pause

Pauses the current speech synthesis task. After the task is paused, you can resume it by calling <a baseurl="t3161921_v1_0_0.xdita" data-node="6176237" data-root="85177" data-tag="xref" href="#448e8ffafd72e" id="6cb9a76d37uvv">nui_tts_resume</a> or cancel it by calling <a baseurl="t3161921_v1_0_0.xdita" data-node="6176237" data-root="85177" data-tag="xref" href="#156934a01bzjc" id="0cb744598acd8">nui_tts_cancel</a>. The SDK does not support starting new synthesis tasks while a task is paused.

Note: This operation only pauses data from being pulled from the server-side. Audio data that is cached in the player continues to play.

• Method signature

  -(int) nui_tts_pause;

• Return value description

  Returns an error code. For more information, see Query error codes.

nui_tts_resume

Resumes a paused speech synthesis task.

• Method signature

  -(int) nui_tts_resume;

• Return value description

  Returns an error code. For more information, see Query error codes.

nui_tts_cancel

Cancels a synthesis task.

Note: This operation only cancels data from being pulled from the server-side. Audio data that is cached in the player continues to play.

• Method signature

  -(int) nui_tts_cancel:(const char *)taskid;

• Parameter descriptions

  Parameter	Type	Description
  taskid	char*	The ID of the task to cancel. If you pass null, all paused or ongoing synthesis tasks are canceled.

• Return value description

  Returns an error code. For more information, see Query error codes.

nui_tts_release

Releases all internal SDK resources and forcibly terminates all ongoing synthesis tasks. After this method is called, the SDK instance becomes unavailable. To use the instance again, you must call <a baseurl="t3161921_v1_0_0.xdita" data-node="6176237" data-root="85177" data-tag="xref" href="#05eab5125e2pm" id="0086f97fefeuw">nui_tts_initialize</a> to re-initialize it.

• Method signature

  -(int) nui_tts_release;

• Return value description

  Returns an error code. For more information, see Query error codes.

onNuiTtsEventCallback: Listen for events

• Method signature

  - (void)onNuiTtsEventCallback:(NuiSdkTtsEvent)event taskId:(char*)taskid code:(int)code;

• Parameter descriptions

  Parameter	Type	Description
  event	NuiSdkTtsEvent	The callback event.
  taskid	char*	The speech synthesis task ID.
  code	int	The error code. This is valid only in the TTS_EVENT_ERROR event. For more information, see Query error codes.

onNuiTtsUserdataCallback: Listen for audio data and timestamp information

• Method signature

  - (void)onNuiTtsUserdataCallback:(char*)info infoLen:(int)info_len buffer:(char*)buffer len:(int)len taskId:(char*)task_id;

• Parameter descriptions

  Parameter	Type	Description
  info	char*	The timestamp result in JSON format. This takes effect when the speech synthesis effect parameter word_timestamp_enabled is set to "1".
  info_len	int	The data length of the info field. You can ignore this.
  buffer	char*	Returns the audio data of the current segment.
  len	int	The length of the audio data in bytes.
  task_id	char*	The speech synthesis task ID.

onNuiTtsLogTrackCallback: Listen for tracking logs

This callback is used to receive detailed internal logs from the SDK for troubleshooting and debugging.

- (void)onNuiTtsLogTrackCallback:(NuiSdkLogLevel)level
                      logMessage:(const char *)log;