ISpTTSEngineSite::GetRate (Windows Embedded CE 6.0)

1/6/2010

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

See Also

Reference

ISpTTSEngine
ISpTTSEngineSite
SAPI Interfaces