TextToSpeechGetRate

The TextToSpeechGetRate call returns the current setting of the speaking rate.

Syntax

MMRESULT TextToSpeechGetRate

(LPTTS_HANDLE_T phTTS,
LPDWORD pdwRate)

Parameters

LPTTS_HANDLE_T phTTS

Specifies a text-to-speech handle.

 

LPDWORD pdwRate

Points to a DWORD that is used to return the speaking rate. Valid values range from 75 to 600 words per minute.

Return Value

This call returns a value of type MMRESULT. The value is zero if the call is successful. The return value is one of the following constants:

Constant

Description

MMSYSERR_NOERROR

Normal successful completion (zero).

MMSYSERR_INVALHANDLE

The text-to-speech handle was invalid.

 

 

Comments

The current setting of the speaking rate is returned even if the speaking rate change has not yet occurred. This may occur when the TextToSpeechSetRate() call is used without the TextToSpeechSync() call. The speaking-rate change occurs on clause boundaries.

See Also

btn_mini.gif TextToSpeechSetRate