NVSClientInit

Initializes the Vocalizer client, supplying the mandatory (and optional) configuration parameters directly in the function call. Mandatory parameters are explicitly required, while other parameters (such as logging parameters) can be passed via keys and values arrays. The format for the function is:

TTSRETVAL NvsClientInit(
  const_char* RMAddresses, 
  const_char* NVSAddress, 
  unsigned_int n_conn_timeout,
  unsigned_int n_client_port, 
  unsigned short n_threads, 
  const_char** v_keys, 
  const_char** v_values, 
  unsigned_short n_params, 
  unsigned int* pnVersion
  );

This function can be used only once, at application startup. It is mutually exclusive with NVSClientInitFromFile().

Argument

Description

RMAddresses

Deprecated. Specify NULL. Any value will be overwritten by NVSAddress.

NVSAddress

The address of the Vocalizer host the client needs to contact. Must be in the form:

IP_address:port

n_conn_timeout

The connection timeout (in milliseconds) that the Vocalizer client waits before assuming there is no Vocalizer host available.

n_client_port

The port opened for a callback channel on the Vocalizer client side.
n_threads

Specify zero (0). Appears in the header file but not used.

The system sets the number of working threads based on the number of configured licensed ports.

v_keys

An array of strings containing the names of optional parameters (that is, all parameters that are not already specified in previous arguments). Use v_values to specify the parameter values, and use n_params as a counter for the array. The optional parameters are:

  • server.nvs-client.LogPath—The path to a directory where diagnostic logs are to be written. If not specified, diagnostic logs are not written.
  • server.nvs-client.LogMaxSize—The maximum size allowed for any one log file, in MB.
  • server.nvs-client.LogLevel—The level of detail for diagnostic logs.

See NVSClientInitFromFile for a discussion of diagnostic logging.

v_values

An array of strings that contains values of optional parameters. Specify values in the same order of the names in the v_keys array.

n_params

The number of parameters in both the v_keys and v_values arrays.

pnVersion

A pointer to a variable that receives the NVS protocol version. Can be set to NULL.

This function or NVSClientInitFromFile must be used before the TtsSystemInit function.