Set configuration properties for all LVTTSClient instances.
Function
- LV_TTS_RETURN_CODE SetClientPropertyEx( int property, int property_value_type, void *pvalue )
Parameters
property
One of several enumerated properties, described in TTS Client Properties.
property_value_type
The value type of the property being set. Legal values are:
PROP_EX_VALUE_TYPE_INT
PROP_EX_VALUE_TYPE_INT_PTR
PROP_EX_VALUE_TYPE_STRING
PROP_EX_VALUE_TYPE_FLOAT_PTR
Each property has a set of legal set of value types. See TTS Client Properties for value types available for each property.
pvalue
A pointer to the new value for the property specified. pvalue will be reinterpreted according to the property_value_type provided.
Return Values
LV_SUCCESS
No errors; the property was successfully set.
LV_INVALID_TTS_HANDLE
The TTS client handle is invalid (either Initialize has not been called or Destroy has already been called).
LV_INVALID_PROPERTY
The specified property is invalid.
LV_INVALID_PROPERTY_VALUE_TYPE
The specified property_value_type is not valid for the specified property.
LV_INVALID_PROPERTY_TARGET
The specified property is not valid to be set for the entire application.
LV_INVALID_API_PARAMETER or LV_FAILURE
The provided pvalue is not valid, not permitted or not in acceptable range.
LV_EXCEPTION
An exception occurred while processing the request.
