ISpTTSEngineSite::GetRate
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets the current TTS rendering rate adjustment for the TTS engine to use. The engine should call this method when a previous call to ISpTTSEngineSite::GetActions returns SPVES_RATE. The method retrieves a baseline rate. The engine should combine additional rate adjustments in the XML state with the baseline rate to determine the actual absolute rate adjustment.
Syntax
HRESULT GetRate(
long* pRateAdjust
);
Parameters
- pRateAdjust
[out] Pointer to the baseline rate.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
E_INVALIDARG |
pRateAdjust is invalid. |
S_OK |
Function completed successfully. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |