ISpTTSEngineSite::GetRate (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3

ISpTTSEngineSite::GetRate

ISpTTSEngineSite::GetRate retrieves the current TTS rendering rate adjustment that should be used by the engine.

HRESULT GetRate(
   long   *pRateAdjust
);

Parameters

pRateAdjust
[out] Pointer to a long which specifies the baseline rate.

Return values

ValueDescription
E_POINTERpRateAdjust is invalid
S_OKFunction completed successfully.

Remarks

This function should be called when a call to GetActions returns SPVES_RATE. The retrieved value establishes a baseline rate. Additional rate adjustments in the XML state should be combined with this value to determine the actual absolute rate adjustment.

Show: