Share via


ISpVoice::SetRate

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method sets the speaking rate of the voice in real time. The default rate for a voice is set through the Speech Control Panel.

Syntax

HRESULT SetRate(
  long RateAdjust
);

Parameters

  • RateAdjust
    [in] Value specifying the speaking rate of the voice. The supported values are in the range -10 to 10. Values outside this range can be truncated.

Return Value

The following table shows the possible return values.

Value Description

S_OK

Function completed successfully.

E_INVALIDARG

One or more arguments are invalid.

Remarks

Voices do not all have the same default rate.

The granularity of the rate is engine dependent.

Applications can adjust the rate of a voice either through this function call, or through XML passed to the voice with the input text of a speak call. The voice should combine rate adjustments made in these two ways to arrive at a final rate.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpVoice
SAPI Interfaces