LV_SRE_CreateClient

Acquires a required license and initializes a speech port client object for a subsequent speech recognition, answering machine detection, DTMF decode or grammar parse operation. The type of license that would be acquired depends on the value set for PROP_EX_LICENSE_TYPE.

Function

HPORT LV_SRE_CreateClient(int* error_return_code, ExportLogMsg log_callback, void* log_callback_user_data, int log_verbosity)

Parameters

error_return_code

An error code indicating why the creation of a speech port client object failed.

log_callback

Pointer to a function which will receive logging information from the object.

log_callback_user_data

A void pointer to client application-defined data. This data will be passed to the ExportLogMsg function to serve as a context in the callback.

log_verbosity

Sets the base verbosity level for log_callback. Range: 0 - 6. All log messages bearing verbosity greater than this value are rejected.

0 - minimal logging info

6 - maximum logging info

Return Values

Non-NULL

Port initialized successfully. Returned value is a handle to the speech port client object.

NULL

The call failed. The reason for the failure will be available in error_return_code.

Possible values returned with error_return_code

LV_SUCCESS

The port opened successfully.

LV_LVLANG_UNDEFINED

There was an environment/config setting issue. See log for more details.

LV_OPEN_PORT_FAILED__LICENSES_EXCEEDED

Failed to acquire the requred license - either no licenses are available or all available licenses are already in use.

LV_EXCEPTION

An exception occured while processing the request.

Remarks