ISpTTSEngineSite::GetRate

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.

HRESULT GetRate(
  long* pRateAdjust
);

Parameters

  • pRateAdjust
    [out] Pointer to the baseline rate.

Return Values

The following table shows the possible return values.

Value Description
E_INVALIDARG pRateAdjust is invalid.
S_OK Function completed successfully.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.

See Also

ISpTTSEngineSite | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.