Sambert Speech Synthesis iOS SDK

​

Getting started

1. Obtain an API key: Obtain an API key
   To grant temporary access permissions to third-party applications or users, or to strictly control access to sensitive data and risky operations such as deletion, use a temporary API key. A temporary API key is valid for 60 seconds and you must obtain a new one after it expires.
2. Download the SDK and run the sample code:
   • Download the latest SDK package.
   • Decompress the ZIP package and add nuisdk.framework to your project.
   • In Build Phases → Link Binary With Libraries, add nuisdk.framework.
   • In General → Frameworks, Libraries, and Embedded Content, set nuisdk.framework to Embed & Sign.
   • Open the sample project in Xcode. The sample code is in the DashSambertTTSViewController class. You can replace the API key to test the feature.

​

Call procedure

1. Initialize the SDK.
2. Set the required parameters. Use the parameters parameter of the nui_tts_initialize method to set connection and control parameters. Use the nui_tts_set_param method to set speech synthesis effect parameters.
3. Call nui_tts_play to start speech synthesis.
4. In the onNuiTtsUserdataCallback callback, you can obtain the audio data and use stream playback. To save the audio locally, you can write the audio to the same file in append mode until the synthesis is complete.
5. After the task is complete, call nui_tts_release to release the SDK resources.

​

Request parameters

​

Connection and control parameters

• Parameter example: The following code provides an example of a JSON string. Not all parameters are listed. You can add parameters as needed during encoding:

{
    "url": "wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference",
    "apikey": "st-****",
    "device_id": "my_device_id"
}

• Parameter descriptions

  Parameter	Type	Required	Description
  url	String	Yes	The service endpoint. Set to wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference. Replace WorkspaceId with your actual workspace ID.
  apikey	String	Yes	The API key. Use a temporary API key for higher security and a shorter validity period. This reduces the risk of long-term key leakage.
  device_id	String	Yes	A unique string that identifies the end user. You can set this to the in-app user ID or a unique device identifier generated by the client. This ID is mainly used for log tracking and troubleshooting.
  debug_path	String	No	The storage path for log files. This parameter takes effect only when save_log is set to YES in the nui_tts_initialize interface call. You must set a log file path. Otherwise, an error is reported. A maximum of two log files are retained locally.
  max_log_file_size	int	No	The maximum size of a log file in bytes. This parameter takes effect only when save_log is set to YES in the nui_tts_initialize interface call. Default value: 104857600 (100 × 1024 × 1024 bytes, which is 100 MiB).
  log_track_level	int	No	The filtering level for log content sent through the log callback (onNuiTtsLogTrackCallback). Default value: 2. Valid values: 0: LOG_LEVEL_VERBOSE 1: LOG_LEVEL_DEBUG 2: LOG_LEVEL_INFO 3: LOG_LEVEL_WARNING 4: LOG_LEVEL_ERROR 5: LOG_LEVEL_NONE (disables this feature) Note: log_track_level and level (set through the nui_tts_initialize interface) together determine the final logs for the callback. A log is sent to the callback only if its level value is greater than or equal to both the log_track_level and level values. For example, if log_track_level is set to 2 (INFO) and level is set to 3 (WARNING), only logs at the WARNING level and higher (value >= 3) are sent to the callback.

​

Speech synthesis effect parameters

​

Key interfaces

​

NeoNuiTts

​

nui_tts_initialize

• 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

​

nui_tts_set_param

• 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

​

nui_tts_get_param

• 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

• 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

​

nui_tts_pause

• Method signature

-(int) nui_tts_pause;

• Return value description

​

nui_tts_resume

• Method signature

-(int) nui_tts_resume;

• Return value description

​

nui_tts_cancel

• 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

​

nui_tts_release

• Method signature

-(int) nui_tts_release;

• Return value description

​

NeoNuiTtsDelegate: Listener callbacks

​

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	Valid only when the TTS_EVENT_ERROR event occurs.

​

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

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

​

NuiSdkTtsEvent: Event types

{
  "header": {
    "task_id": "xxxxxxxxx",
    "event": "task-failed",
    "error_code": "InvalidParameter",
    "error_message": "Please ensure input text is valid.",
    "attributes": {}
  },
  "payload": {}
}

​

Model list